<!DOCTYPE html> 
<html lang='en-US' xml:lang='en-US'> 
<head><title>Configuration</title> 
<meta charset='utf-8' /> 
<meta content='TeX4ht (https://tug.org/tex4ht/)' name='generator' /> 
<meta content='width=device-width,initial-scale=1' name='viewport' /> 
<link href='Configuration.css' rel='stylesheet' type='text/css' /> 
<meta content='Configuration.tex' name='src' /> 
<link rel="stylesheet" type="text/css" href="../main.css" /></head><body>
<!-- l. 81 --><p class='noindent'>
                                                                                                  
                                                                                                  
</p>
<div class='center'>
<!-- l. 82 --><p class='noindent'>
</p><!-- l. 89 --><p class='noindent'> <img alt='PIC' height='160' src='Logos/Logo.png' width='160' />
</p><!-- l. 93 --><p class='noindent'><span class='ec-lmssbx-10x-x-248'>OpenCore</span>
</p><!-- l. 97 --><p class='noindent'><span class='ec-lmss-17x-x-143'>Reference Manual (0.8.2)</span>
</p><!-- l. 101 --><p class='noindent'><span class='ec-lmss-17x-x-143'>[2022.06.13]</span>
</p><!-- l. 109 --><p class='noindent'>Copyright <span class='ts1-lmr10-'>©</span>2018-2022 vit9696
</p>
</div>
                                                                                                  
                                                                                                  
<h3 class='likesectionHead' id='contents'><a id='x1-1000'></a>Contents</h3>
<div class='tableofcontents'>
 <span class='sectionToc'>1 <a href='#introduction' id='QQ2-1-2'>Introduction</a></span>
<br />  <span class='subsectionToc'>1.1 <a href='#generic-terms' id='QQ2-1-3'>Generic Terms</a></span>
<br /> <span class='sectionToc'>2 <a href='#configuration' id='QQ2-1-4'>Configuration</a></span>
<br />  <span class='subsectionToc'>2.1 <a href='#configuration-terms' id='QQ2-1-5'>Configuration Terms</a></span>
<br />  <span class='subsectionToc'>2.2 <a href='#configuration-processing' id='QQ2-1-6'>Configuration Processing</a></span>
<br />  <span class='subsectionToc'>2.3 <a href='#configuration-structure' id='QQ2-1-7'>Configuration Structure</a></span>
<br /> <span class='sectionToc'>3 <a href='#setup' id='QQ2-1-8'>Setup</a></span>
<br />  <span class='subsectionToc'>3.1 <a href='#directory-structure' id='QQ2-1-9'>Directory Structure</a></span>
<br />  <span class='subsectionToc'>3.2 <a href='#installation-and-upgrade' id='QQ2-1-10'>Installation and Upgrade</a></span>
<br />  <span class='subsectionToc'>3.3 <a href='#contribution' id='QQ2-1-11'>Contribution</a></span>
<br />  <span class='subsectionToc'>3.4 <a href='#coding-conventions' id='QQ2-1-14'>Coding conventions</a></span>
<br />  <span class='subsectionToc'>3.5 <a href='#debugging' id='QQ2-1-15'>Debugging</a></span>
<br /> <span class='sectionToc'>4 <a href='#acpi' id='QQ2-1-16'>ACPI</a></span>
<br />  <span class='subsectionToc'>4.1 <a href='#introduction1' id='QQ2-1-17'>Introduction</a></span>
<br />  <span class='subsectionToc'>4.2 <a href='#properties' id='QQ2-1-18'>Properties</a></span>
<br />  <span class='subsectionToc'>4.3 <a href='#add-properties' id='QQ2-1-19'>Add Properties</a></span>
<br />  <span class='subsectionToc'>4.4 <a href='#delete-properties' id='QQ2-1-20'>Delete Properties</a></span>
<br />  <span class='subsectionToc'>4.5 <a href='#patch-properties' id='QQ2-1-21'>Patch Properties</a></span>
<br />  <span class='subsectionToc'>4.6 <a href='#quirks-properties' id='QQ2-1-22'>Quirks Properties</a></span>
<br /> <span class='sectionToc'>5 <a href='#booter' id='QQ2-1-23'>Booter</a></span>
<br />  <span class='subsectionToc'>5.1 <a href='#introduction2' id='QQ2-1-24'>Introduction</a></span>
<br />  <span class='subsectionToc'>5.2 <a href='#properties1' id='QQ2-1-25'>Properties</a></span>
<br />  <span class='subsectionToc'>5.3 <a href='#mmiowhitelist-properties' id='QQ2-1-26'>MmioWhitelist Properties</a></span>
<br />  <span class='subsectionToc'>5.4 <a href='#patch-properties1' id='QQ2-1-27'>Patch Properties</a></span>
<br />  <span class='subsectionToc'>5.5 <a href='#quirks-properties1' id='QQ2-1-28'>Quirks Properties</a></span>
<br /> <span class='sectionToc'>6 <a href='#deviceproperties' id='QQ2-1-29'>DeviceProperties</a></span>
<br />  <span class='subsectionToc'>6.1 <a href='#introduction3' id='QQ2-1-30'>Introduction</a></span>
<br />  <span class='subsectionToc'>6.2 <a href='#properties2' id='QQ2-1-31'>Properties</a></span>
<br />  <span class='subsectionToc'>6.3 <a href='#common-properties' id='QQ2-1-32'>Common Properties</a></span>
<br /> <span class='sectionToc'>7 <a href='#kernel' id='QQ2-1-33'>Kernel</a></span>
<br />  <span class='subsectionToc'>7.1 <a href='#introduction4' id='QQ2-1-34'>Introduction</a></span>
<br />  <span class='subsectionToc'>7.2 <a href='#properties3' id='QQ2-1-35'>Properties</a></span>
<br />  <span class='subsectionToc'>7.3 <a href='#add-properties1' id='QQ2-1-36'>Add Properties</a></span>
<br />  <span class='subsectionToc'>7.4 <a href='#block-properties' id='QQ2-1-37'>Block Properties</a></span>
<br />  <span class='subsectionToc'>7.5 <a href='#emulate-properties' id='QQ2-1-38'>Emulate Properties</a></span>
                                                                                                  
                                                                                                  
<br />  <span class='subsectionToc'>7.6 <a href='#force-properties' id='QQ2-1-39'>Force Properties</a></span>
<br />  <span class='subsectionToc'>7.7 <a href='#patch-properties2' id='QQ2-1-40'>Patch Properties</a></span>
<br />  <span class='subsectionToc'>7.8 <a href='#quirks-properties2' id='QQ2-1-41'>Quirks Properties</a></span>
<br />  <span class='subsectionToc'>7.9 <a href='#scheme-properties' id='QQ2-1-42'>Scheme Properties</a></span>
<br /> <span class='sectionToc'>8 <a href='#misc' id='QQ2-1-43'>Misc</a></span>
<br />  <span class='subsectionToc'>8.1 <a href='#introduction5' id='QQ2-1-44'>Introduction</a></span>
<br />  <span class='subsectionToc'>8.2 <a href='#properties4' id='QQ2-1-45'>Properties</a></span>
<br />  <span class='subsectionToc'>8.3 <a href='#boot-properties' id='QQ2-1-46'>Boot Properties</a></span>
<br />  <span class='subsectionToc'>8.4 <a href='#debug-properties' id='QQ2-1-47'>Debug Properties</a></span>
<br />  <span class='subsectionToc'>8.5 <a href='#security-properties' id='QQ2-1-48'>Security Properties</a></span>
<br />  <span class='subsectionToc'>8.6 <a href='#serial-properties' id='QQ2-1-49'>Serial Properties</a></span>
<br />  <span class='subsectionToc'>8.7 <a href='#entry-properties' id='QQ2-1-51'>Entry Properties</a></span>
<br /> <span class='sectionToc'>9 <a href='#nvram' id='QQ2-1-52'>NVRAM</a></span>
<br />  <span class='subsectionToc'>9.1 <a href='#introduction6' id='QQ2-1-53'>Introduction</a></span>
<br />  <span class='subsectionToc'>9.2 <a href='#properties5' id='QQ2-1-54'>Properties</a></span>
<br />  <span class='subsectionToc'>9.3 <a href='#mandatory-variables' id='QQ2-1-55'>Mandatory Variables</a></span>
<br />  <span class='subsectionToc'>9.4 <a href='#recommended-variables' id='QQ2-1-56'>Recommended Variables</a></span>
<br />  <span class='subsectionToc'>9.5 <a href='#other-variables' id='QQ2-1-57'>Other Variables</a></span>
<br /> <span class='sectionToc'>10 <a href='#platforminfo' id='QQ2-1-58'>PlatformInfo</a></span>
<br />  <span class='subsectionToc'>10.1 <a href='#properties6' id='QQ2-1-59'>Properties</a></span>
<br />  <span class='subsectionToc'>10.2 <a href='#generic-properties' id='QQ2-1-60'>Generic Properties</a></span>
<br />  <span class='subsectionToc'>10.3 <a href='#datahub-properties' id='QQ2-1-61'>DataHub Properties</a></span>
<br />  <span class='subsectionToc'>10.4 <a href='#memory-properties' id='QQ2-1-62'>Memory Properties</a></span>
<br />  <span class='subsectionToc'>10.5 <a href='#platformnvram-properties' id='QQ2-1-64'>PlatformNVRAM Properties</a></span>
<br />  <span class='subsectionToc'>10.6 <a href='#smbios-properties' id='QQ2-1-65'>SMBIOS Properties</a></span>
<br /> <span class='sectionToc'>11 <a href='#uefi' id='QQ2-1-66'>UEFI</a></span>
<br />  <span class='subsectionToc'>11.1 <a href='#introduction7' id='QQ2-1-67'>Introduction</a></span>
<br />  <span class='subsectionToc'>11.2 <a href='#drivers' id='QQ2-1-68'>Drivers</a></span>
<br />  <span class='subsectionToc'>11.3 <a href='#tools-and-applications' id='QQ2-1-69'>Tools and Applications</a></span>
<br />  <span class='subsectionToc'>11.4 <a href='#opencanopy' id='QQ2-1-71'>OpenCanopy</a></span>
<br />  <span class='subsectionToc'>11.5 <a href='#openruntime' id='QQ2-1-72'>OpenRuntime</a></span>
<br />  <span class='subsectionToc'>11.6 <a href='#openlinuxboot' id='QQ2-1-73'>OpenLinuxBoot</a></span>
<br />  <span class='subsectionToc'>11.7 <a href='#other-boot-entry-protocol-drivers' id='QQ2-1-76'>Other Boot Entry Protocol drivers</a></span>
<br />  <span class='subsectionToc'>11.8 <a href='#audiodxe' id='QQ2-1-79'>AudioDxe</a></span>
<br />  <span class='subsectionToc'>11.9 <a href='#properties7' id='QQ2-1-81'>Properties</a></span>
<br />  <span class='subsectionToc'>11.10 <a href='#apfs-properties' id='QQ2-1-82'>APFS Properties</a></span>
<br />  <span class='subsectionToc'>11.11 <a href='#appleinput-properties' id='QQ2-1-83'>AppleInput Properties</a></span>
<br />  <span class='subsectionToc'>11.12 <a href='#audio-properties' id='QQ2-1-84'>Audio Properties</a></span>
                                                                                                  
                                                                                                  
<br />  <span class='subsectionToc'>11.13 <a href='#drivers-properties' id='QQ2-1-85'>Drivers Properties</a></span>
<br />  <span class='subsectionToc'>11.14 <a href='#input-properties' id='QQ2-1-86'>Input Properties</a></span>
<br />  <span class='subsectionToc'>11.15 <a href='#output-properties' id='QQ2-1-87'>Output Properties</a></span>
<br />  <span class='subsectionToc'>11.16 <a href='#protocoloverrides-properties' id='QQ2-1-88'>ProtocolOverrides Properties</a></span>
<br />  <span class='subsectionToc'>11.17 <a href='#quirks-properties3' id='QQ2-1-89'>Quirks Properties</a></span>
<br />  <span class='subsectionToc'>11.18 <a href='#reservedmemory-properties' id='QQ2-1-90'>ReservedMemory Properties</a></span>
<br /> <span class='sectionToc'>12 <a href='#troubleshooting' id='QQ2-1-91'>Troubleshooting</a></span>
<br />  <span class='subsectionToc'>12.1 <a href='#legacy-apple-os' id='QQ2-1-92'>Legacy Apple OS</a></span>
<br />  <span class='subsectionToc'>12.2 <a href='#uefi-secure-boot' id='QQ2-1-98'>UEFI Secure Boot</a></span>
<br />  <span class='subsectionToc'>12.3 <a href='#windows-support' id='QQ2-1-99'>Windows support</a></span>
<br />  <span class='subsectionToc'>12.4 <a href='#debugging1' id='QQ2-1-101'>Debugging</a></span>
<br />  <span class='subsectionToc'>12.5 <a href='#tips-and-tricks' id='QQ2-1-102'>Tips and Tricks</a></span>
</div>
<!-- l. 116 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='introduction'><span class='titlemark'>1   </span> <a id='x1-20001'></a>Introduction</h3>
<!-- l. 118 --><p class='noindent'>This document provides information on the format of the <a href='https://github.com/acidanthera/OpenCorePkg'>OpenCore</a> user configuration file used to set up the correct
functioning of the macOS operating system. It is to be read as the official clarification of expected OpenCore behaviour. All
deviations, if found in published OpenCore releases, shall be considered to be documentation or implementation
issues which should be reported via the <a href='https://github.com/acidanthera/bugtracker'>Acidanthera Bugtracker</a>. An errata sheet is available in <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/Errata/Errata.pdf'>OpenCorePkg
repository</a>.
</p><!-- l. 128 --><p class='noindent'>This document is structured as a specification and is not meant to provide a step-by-step guide to configuring an end-user
Board Support Package (BSP). The intended audience of the document is anticipated to be programmers and engineers with a
basic understanding of macOS internals and UEFI functionality. For these reasons, this document is available
exclusively in English, and all other sources or translations of this document are unofficial and may contain
errors.
</p><!-- l. 135 --><p class='noindent'>Third-party articles, utilities, books, and similar, may be more useful for a wider audience as they could provide guide-like
material. However, they are subject to their authors’ preferences, misinterpretations of this document, and unavoidable
obsolescence. In cases of using such sources, such as <a href='https://dortania.github.io'>Dortania</a>’s <a href='https://dortania.github.io/OpenCore-Install-Guide'>OpenCore Install Guide</a> and <a href='https://dortania.github.io/getting-started'>related material</a>, please refer back
to this document on every decision made and re-evaluate potential implications.
</p><!-- l. 143 --><p class='noindent'>Please note that regardless of the sources used, users are required to fully understand every OpenCore configuration option,
and the principles behind them, before posting issues to the <a href='https://github.com/acidanthera/bugtracker'>Acidanthera Bugtracker</a>.
</p><!-- l. 147 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Creating this document would not have been possible without the invaluable contributions from other people:
Andrey1970, Goldfish64, dakanji, PMheart, and several others, with the full list available in <a href='https://github.com/acidanthera/OpenCorePkg/commits/master/Docs'>OpenCorePkg
history</a>.
</p><!-- l. 152 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='generic-terms'><span class='titlemark'>1.1   </span> <a id='x1-30001.1'></a>Generic Terms</h4>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>plist </span>—  Subset  of  ASCII  Property  List  format  written  in  XML,  also  know  as  XML  plist  format  version
     1.  Uniform  Type  Identifier  (UTI):  <span class='ec-lmtt-10'>com.apple.property-list</span>.  Plists  consist  of  <span class='ec-lmtt-10'>plist objects</span>,  which  are
     combined to form a hierarchical structure. Due to plist format not being well-defined, all the definitions of this
     document may only be applied after plist is considered valid by running <span class='ec-lmtt-10'>plutil -lint</span>. External references:
     https://www.apple.com/DTDs/PropertyList-1.0.dtd, <span class='ec-lmtt-10'>man plutil</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist type </span>— plist collections (<span class='ec-lmtt-10'>plist array</span>, <span class='ec-lmtt-10'>plist dictionary</span>, <span class='ec-lmtt-10'>plist key</span>) and primitives (<span class='ec-lmtt-10'>plist string</span>,
     <span class='ec-lmtt-10'>plist data</span>, <span class='ec-lmtt-10'>plist date</span>, <span class='ec-lmtt-10'>plist boolean</span>, <span class='ec-lmtt-10'>plist integer</span>, <span class='ec-lmtt-10'>plist real</span>).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist object </span>— definite realisation of <span class='ec-lmtt-10'>plist type</span>, which may be interpreted as value.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist array </span>— array-like collection, conforms to <span class='ec-lmtt-10'>array</span>. Consists of zero or more <span class='ec-lmtt-10'>plist objects</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist dictionary </span>—  map-like  (associative  array)  collection,  conforms  to  <span class='ec-lmtt-10'>dict</span>.  Consists  of  zero  or  more
     <span class='ec-lmtt-10'>plist keys</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist key </span>— contains one <span class='ec-lmtt-10'>plist object </span>going by the name of <span class='ec-lmtt-10'>plist key</span>, conforms to <span class='ec-lmtt-10'>key</span>. Consists of printable
     7-bit ASCII characters.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist string </span>— printable 7-bit ASCII string, conforms to <span class='ec-lmtt-10'>string</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist data </span>— base64-encoded blob, conforms to <span class='ec-lmtt-10'>data</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist date </span>— ISO-8601 date, conforms to <span class='ec-lmtt-10'>date</span>, unsupported.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist boolean </span>— logical state object, which is either true (1) or false (0), conforms to <span class='ec-lmtt-10'>true </span>and <span class='ec-lmtt-10'>false</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist integer </span>— possibly signed integer number in base 10, conforms to <span class='ec-lmtt-10'>integer</span>. Fits in 64-bit unsigned integer
     in two’s complement representation, unless a smaller signed or unsigned integral type is explicitly mentioned in
     specific <span class='ec-lmtt-10'>plist object </span>description.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist real </span>— floating point number, conforms to <span class='ec-lmtt-10'>real</span>, unsupported.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>plist multidata </span>— value cast to data by the implementation. Permits passing <span class='ec-lmtt-10'>plist string</span>, in which case the
     result is represented by a null-terminated sequence of bytes (C string), <span class='ec-lmtt-10'>plist integer</span>, in which case the result
     is represented by <span class='ec-lmri-10'>32-bit </span>little endian sequence of bytes in two’s complement representation, <span class='ec-lmtt-10'>plist boolean</span>, in
     which case the value is one byte: <span class='ec-lmtt-10'>01 </span>for <span class='ec-lmtt-10'>true </span>and <span class='ec-lmtt-10'>00 </span>for <span class='ec-lmtt-10'>false</span>, and <span class='ec-lmtt-10'>plist data </span>itself. All other types or larger
     integers invoke undefined behaviour.</li></ul>
<!-- l. 218 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='configuration'><span class='titlemark'>2   </span> <a id='x1-40002'></a>Configuration</h3>
<!-- l. 220 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='configuration-terms'><span class='titlemark'>2.1   </span> <a id='x1-50002.1'></a>Configuration Terms</h4>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>OC config </span>— OpenCore Configuration file in <span class='ec-lmtt-10'>plist </span>format named <span class='ec-lmtt-10'>config.plist</span>. It provides an extensible way
     to configure OpenCore and is structured to be separated into multiple named sections situated under the root
     <span class='ec-lmtt-10'>plist dictionary</span>. These sections may have <span class='ec-lmtt-10'>plist array </span>or <span class='ec-lmtt-10'>plist dictionary </span>types and are described in
     corresponding sections of this document.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>valid key </span>— <span class='ec-lmtt-10'>plist key </span>object of <span class='ec-lmtt-10'>OC config </span>described in this document or its future revisions. Besides explicitly
     described <span class='ec-lmtt-10'>valid keys</span>, keys starting with the <span class='ec-lmtt-10'># </span>symbol (e.g. <span class='ec-lmtt-10'>#Hello</span>) are also considered <span class='ec-lmtt-10'>valid keys </span>and while
     they behave as comments, effectively discarding their values, they are still required to be valid <span class='ec-lmtt-10'>plist objects</span>.
     All other <span class='ec-lmtt-10'>plist keys </span>are not valid, and their presence results in <span class='ec-lmtt-10'>undefined behaviour</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>valid value </span>— valid <span class='ec-lmtt-10'>plist object </span>of <span class='ec-lmtt-10'>OC config </span>described in this document that matches all the additional
     requirements in specific <span class='ec-lmtt-10'>plist object </span>descriptions if any.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>invalid value </span>— valid <span class='ec-lmtt-10'>plist object </span>of <span class='ec-lmtt-10'>OC config </span>described in this document that is of other <span class='ec-lmtt-10'>plist type</span>,
     does not conform to additional requirements found in specific <span class='ec-lmtt-10'>plist object </span>descriptions (e.g. value range), or
     missing from the corresponding collection. <span class='ec-lmtt-10'>Invalid values </span>are read with or without an error message as any
     possible value of this <span class='ec-lmtt-10'>plist object </span>in an undetermined manner (i.e. the values may not be same across the
     reboots). Whilst reading an <span class='ec-lmtt-10'>invalid value </span>is equivalent to reading certain defined <span class='ec-lmtt-10'>valid values</span>, applying
     incompatible values to the host system may result in <span class='ec-lmtt-10'>undefined behaviour</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>optional value </span>— <span class='ec-lmtt-10'>valid value </span>of <span class='ec-lmtt-10'>OC config </span>described in this document that reads in a certain defined manner
     provided in specific <span class='ec-lmtt-10'>plist object </span>description (instead of <span class='ec-lmtt-10'>invalid value</span>) when not present in <span class='ec-lmtt-10'>OC config</span>. All
     other cases of <span class='ec-lmtt-10'>invalid value </span>do still apply. Unless explicitly marked as <span class='ec-lmtt-10'>optional value</span>, any other value is
     required to be present and reads to <span class='ec-lmtt-10'>invalid value </span>if missing.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>fatal behaviour </span>— behaviour leading to boot termination. Implementations shall prevent the boot process
     from continuing until the host system is restarted. It is permitted, but not required, to execute cold reboots or
     to show warning messages in such cases.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>undefined behaviour </span>— behaviour not prescribed by this document. Implementations may take any measures
     including, but not limited to, measures associated with <span class='ec-lmtt-10'>fatal behaviour</span>, assumptions of any state or value, or
     disregarding any associated states or values. This is however subject to such measures not negatively impacting
     upon system integrity.</li></ul>
<!-- l. 279 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='configuration-processing'><span class='titlemark'>2.2   </span> <a id='x1-60002.2'></a>Configuration Processing</h4>
<!-- l. 281 --><p class='noindent'>The <span class='ec-lmtt-10'>OC config </span>file is guaranteed to be processed at least once if found. Subject to the OpenCore bootstrapping mechanism,
the presence of multiple <span class='ec-lmtt-10'>OC config </span>files may lead to the reading of any of them. It is permissible for no <span class='ec-lmtt-10'>OC Config </span>file to be
present on disk. In such cases, if the implementation does not abort the boot process, all values shall follow the rules of
<span class='ec-lmtt-10'>invalid values </span>and <span class='ec-lmtt-10'>optional values</span>.
</p><!-- l. 288 --><p class='noindent'>The <span class='ec-lmtt-10'>OC config </span>file has restrictions on size, nesting levels, and number of keys:
</p>
     <ul class='itemize1'>
     <li class='itemize'>The <span class='ec-lmtt-10'>OC config </span>file size shall not exceed <span class='ec-lmtt-10'>32 MBs</span>.
     </li>
     <li class='itemize'>The <span class='ec-lmtt-10'>OC config </span>file shall not have more than <span class='ec-lmtt-10'>32 </span>nesting levels.
     </li>
     <li class='itemize'>
     <!-- l. 297 --><p class='noindent'>The <span class='ec-lmtt-10'>OC config </span>file may have up to <span class='ec-lmtt-10'>32,768 </span>XML nodes within each <span class='ec-lmtt-10'>plist object</span>. </p>
         <ul class='itemize2'>
         <li class='itemize'>One <span class='ec-lmtt-10'>plist dictionary </span>item is counted as a pair of nodes</li></ul>
     </li></ul>
<!-- l. 305 --><p class='noindent'>Reading malformed <span class='ec-lmtt-10'>OC config </span>files results in <span class='ec-lmtt-10'>undefined behaviour</span>. Examples of malformed <span class='ec-lmtt-10'>OC config </span>files include the
following:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>OC config </span>files that do not conform to <span class='ec-lmtt-10'>DTD PLIST 1.0</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>OC config </span>files with unsupported or non-conformant <span class='ec-lmtt-10'>plist objects </span>found in this document.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>OC config </span>files violating restrictions on size, nesting levels, and number of keys.</li></ul>
                                                                                                  
                                                                                                  
<!-- l. 320 --><p class='noindent'>It is recommended, but not required, to abort loading malformed <span class='ec-lmtt-10'>OC config </span>files and to continue as if an <span class='ec-lmtt-10'>OC config </span>file is not
present. For forward compatibility, it is recommended, but not required, for the implementation to warn about the use of
<span class='ec-lmtt-10'>invalid values</span>.
</p><!-- l. 325 --><p class='noindent'>The recommended approach to interpreting <span class='ec-lmtt-10'>invalid values </span>is to conform to the following convention where
applicable:
</p>
<div class='center'>
<!-- l. 328 --><p class='noindent'>
</p>
<div class='tabular'> <table class='tabular' id='TBL-1'><colgroup id='TBL-1-1g'><col id='TBL-1-1' /></colgroup><colgroup id='TBL-1-2g'><col id='TBL-1-2' /></colgroup><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-1-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-1-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmbx-10'>Type            </span></td><td class='td11' id='TBL-1-1-2' style='white-space:nowrap; text-align:left;'><span class='ec-lmbx-10'>Value                                  </span></td>
</tr><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-2-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-2-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmtt-10'>plist string  </span></td><td class='td11' id='TBL-1-2-2' style='white-space:nowrap; text-align:left;'>Empty string (<span class='ec-lmtt-10'>&lt;string&gt;&lt;/string&gt;</span>)</td>
</tr><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-3-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-3-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmtt-10'>plist data    </span></td><td class='td11' id='TBL-1-3-2' style='white-space:nowrap; text-align:left;'>Empty data (<span class='ec-lmtt-10'>&lt;data&gt;&lt;/data&gt;</span>)        </td>
</tr><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-4-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-4-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmtt-10'>plist integer </span></td><td class='td11' id='TBL-1-4-2' style='white-space:nowrap; text-align:left;'>0 (<span class='ec-lmtt-10'>&lt;integer&gt;0&lt;/integer&gt;</span>)           </td>
</tr><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-5-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-5-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmtt-10'>plist boolean </span></td><td class='td11' id='TBL-1-5-2' style='white-space:nowrap; text-align:left;'>False (<span class='ec-lmtt-10'>&lt;false/&gt;</span>)                         </td>
</tr><tr class='hline'><td></td><td></td></tr><tr id='TBL-1-6-' style='vertical-align:baseline;'><td class='td11' id='TBL-1-6-1' style='white-space:nowrap; text-align:left;'><span class='ec-lmtt-10'>plist tristate</span></td><td class='td11' id='TBL-1-6-2' style='white-space:nowrap; text-align:left;'>False (<span class='ec-lmtt-10'>&lt;false/&gt;</span>)                         </td>
</tr><tr class='hline'><td></td><td></td></tr></table>                                                                                                  </div></div>
<!-- l. 351 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='configuration-structure'><span class='titlemark'>2.3   </span> <a id='x1-70002.3'></a>Configuration Structure</h4>
<!-- l. 353 --><p class='noindent'>The <span class='ec-lmtt-10'>OC config </span>file is separated into subsections, as described in separate sections of this document, and is designed so as to
attempt not to enable anything by default as well as to provide kill switches via an <span class='ec-lmtt-10'>Enable </span>property for <span class='ec-lmtt-10'>plist dict </span>entries
that represent optional plugins and similar.
</p><!-- l. 358 --><p class='noindent'>The file is structured to group related elements in subsections as follows:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>Add </span>provides support for data addition. Existing data will not be overridden, and needs to be handled separately
     with <span class='ec-lmtt-10'>Delete </span>if necessary.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Delete </span>provides support for data removal.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Patch </span>provides support for data modification.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Quirks </span>provides support for specific workarounds.</li></ul>
<!-- l. 374 --><p class='noindent'>Root configuration entries consist of the following:
</p>
     <ul class='itemize1'>
     <li class='itemize'><a href='#acpi'><span class='ec-lmtt-10'>ACPI</span></a>
     </li>
     <li class='itemize'><a href='#booter'><span class='ec-lmtt-10'>Booter</span></a>
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><a href='#deviceproperties'><span class='ec-lmtt-10'>DeviceProperties</span></a>
     </li>
     <li class='itemize'><a href='#kernel'><span class='ec-lmtt-10'>Kernel</span></a>
     </li>
     <li class='itemize'><a href='#misc'><span class='ec-lmtt-10'>Misc</span></a>
     </li>
     <li class='itemize'><a href='#nvram'><span class='ec-lmtt-10'>NVRAM</span></a>
     </li>
     <li class='itemize'><a href='#platforminfo'><span class='ec-lmtt-10'>PlatformInfo</span></a>
     </li>
     <li class='itemize'><a href='#uefi'><span class='ec-lmtt-10'>UEFI</span></a></li></ul>
<!-- l. 396 --><p class='noindent'>Basic validation of an <span class='ec-lmtt-10'>OC config </span>file is possible using the <span class='ec-lmtt-10'>ocvalidate </span>utility. Please note that the version of <span class='ec-lmtt-10'>ocvalidate </span>used
must match the OpenCore release and that notwithstanding this, it may not detect all configuration issues present in an
<span class='ec-lmtt-10'>OC config </span>file.
</p><!-- l. 401 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: To maintain system integrity, properties typically have predefined values even when such predefined values are not
specified in the <span class='ec-lmtt-10'>OC config </span>file. However, all properties must be explicitly specified in the <span class='ec-lmtt-10'>OC config </span>file and this behaviour
should not be relied on.
</p><!-- l. 406 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='setup'><span class='titlemark'>3   </span> <a id='x1-80003'></a>Setup</h3>
<!-- l. 408 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='directory-structure'><span class='titlemark'>3.1   </span> <a id='x1-90003.1'></a>Directory Structure</h4>
<div class='center'>
<!-- l. 410 --><p class='noindent'>
</p><!-- l. 411 --><p class='noindent'><img alt='EEBBOADSMDMOKMORAFImLTTOcvvKkkpbnopSSFOOCCSSYryteyteuoaaoopoaaeeerovpayPIOOPDDTiDhxKhsdngbooenuurrnrnelorensTTITTAvereteeoiteelsl.nfiltltneeintamnicRx.BrirsxruoleCg.p.sellk.c-e6a-1LsvDtKrfio.plilscepoYp4m.Eer.ecerligadlreYo.la.rivkxseisstchki-Yrema.eeet.teestYYtlmfirx.kerYfil.etefinYfixeY-MtlM-MM-DD -D-DHH-MHMHSMSM.StSx.ttxt  ' src='Configuration0x.svg' />
 Figure 1. Directory Structure</p></div>
<!-- l. 508 --><p class='noindent'>When directory boot is used, the directory structure used should follow the descriptions in the <a href='#directory-structure'>Directory Structure</a> figure.
Available entries include:
</p>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>BOOTx64.efi </span>or <span class='ec-lmtt-10'>BOOTIa32.efi </span><br class='newline' />Initial bootstrap loaders, which load <span class='ec-lmtt-10'>OpenCore.efi</span>. <span class='ec-lmtt-10'>BOOTx64.efi </span>is loaded by the firmware by default consistent
     with the UEFI specification. However, it may also be renamed and put in a custom location to allow OpenCore
     coexist alongside operating systems, such as Windows, that use <span class='ec-lmtt-10'>BOOTx64.efi </span>files as their loaders. Refer to the
     <span class='ec-lmtt-10'>LauncherOption </span>property for details.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>boot </span><br class='newline' />Duet bootstrap loader, which initialises the UEFI environment on legacy BIOS firmware and loads <span class='ec-lmtt-10'>OpenCore.efi</span>
     similarly to other bootstrap loaders. A modern Duet bootstrap loader will default to <span class='ec-lmtt-10'>OpenCore.efi </span>on the same
     partition when present.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>ACPI </span><br class='newline' />Directory used for storing supplemental ACPI information for the <a href='#acpi'><span class='ec-lmtt-10'>ACPI</span></a> section.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Drivers </span><br class='newline' />Directory used for storing supplemental <span class='ec-lmtt-10'>UEFI </span>drivers for <a href='#uefi'><span class='ec-lmtt-10'>UEFI</span></a> section.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Kexts </span><br class='newline' />Directory used for storing supplemental kernel information for the <a href='#kernel'><span class='ec-lmtt-10'>Kernel</span></a> section.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Resources </span><br class='newline' />Directory used for storing media resources such as audio files for screen reader support. Refer to the <a href='#audio-properties'><span class='ec-lmtt-10'>UEFI Audio
     </span><span class='ec-lmtt-10'>Properties</span></a> section for details. This directory also contains image files for graphical user interface. Refer to the
     <a href='#opencanopy'>OpenCanopy</a> section for details.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Tools </span><br class='newline' />Directory used for storing supplemental tools.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>OpenCore.efi </span><br class='newline' />Main booter application responsible for operating system loading. The directory <span class='ec-lmtt-10'>OpenCore.efi </span>resides in is called
     the <span class='ec-lmtt-10'>root directory</span>, which is set to <span class='ec-lmtt-10'>EFI\OC </span>by default. When launching <span class='ec-lmtt-10'>OpenCore.efi </span>directly or through a
     custom launcher however, other directories containing <span class='ec-lmtt-10'>OpenCore.efi </span>files are also supported.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>config.plist </span><br class='newline' /><span class='ec-lmtt-10'>OC Config</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>vault.plist </span><br class='newline' />Hashes for all files potentially loadable by <span class='ec-lmtt-10'>OC Config</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>vault.sig </span><br class='newline' />Signature for <span class='ec-lmtt-10'>vault.plist</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SysReport </span><br class='newline' />Directory containing system reports generated by <span class='ec-lmtt-10'>SysReport </span>option.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>nvram.plist </span><br class='newline' />OpenCore variable import file.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>opencore-YYYY-MM-DD-HHMMSS.txt </span><br class='newline' />OpenCore log file.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>panic-YYYY-MM-DD-HHMMSS.txt </span><br class='newline' />Kernel panic log file.</li></ul>
<!-- l. 578 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: It is not guaranteed that paths longer than <span class='ec-lmtt-10'>OC_STORAGE_SAFE_PATH_MAX </span>(128 characters including the
<br class='newline' /><span class='ec-lmtt-10'>0</span>-terminator) will be accessible within OpenCore.
</p><!-- l. 582 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='installation-and-upgrade'><span class='titlemark'>3.2   </span> <a id='x1-100003.2'></a>Installation and Upgrade</h4>
<!-- l. 584 --><p class='noindent'>To install OpenCore, replicate the <a href='#configuration-structure'>Configuration Structure</a> described in the previous section in the EFI volume of a
GPT partition. While corresponding sections of this document provide some information regarding external
resources such as ACPI tables, UEFI drivers, or kernel extensions (kexts), completeness of the matter is out of the
scope of this document. Information about kernel extensions may be found in a separate <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/Kexts.md'>Kext List</a> document
available in the OpenCore repository. Vaulting information is provided in the <a href='#security-properties'>Security Properties</a> section of this
document.
</p><!-- l. 596 --><p class='noindent'>The <span class='ec-lmtt-10'>OC config </span>file, as with any property list file, can be edited with any text editor, such as nano or vim. However, specialised
software may provide a better experience. On macOS, the preferred GUI application is <a href='https://developer.apple.com/xcode'>Xcode</a>. The <a href='https://github.com/corpnewt/ProperTree'>ProperTree</a> editor is a
lightweight, cross-platform and open-source alternative.
</p><!-- l. 603 --><p class='noindent'>It is strongly recommended to avoid configuration creation tools that are aware of the internal configuration structure as this
may result in invalid configurations (since the structure gets constantly updated). If such tools are to be used despite this
warning, ensure that only stable versions of OpenCore explicitly supported by such tools are used. In such cases, the use of
open-source implementations with transparent binary generation (such as <a href='https://github.com/ic005k/QtOpenCoreConfig'>OCAT</a>) is encouraged, given that other tools may
contain malware. In addition, configurations created for a specific hardware setup should never be used on different hardware
setups.
</p><!-- l. 612 --><p class='noindent'>For BIOS booting, a third-party UEFI environment provider is required and <span class='ec-lmtt-10'>OpenDuetPkg </span>is one such UEFI environment
provider for legacy systems. To run OpenCore on such a legacy system, <span class='ec-lmtt-10'>OpenDuetPkg </span>can be installed with a dedicated tool —
BootInstall (bundled with OpenCore). <a href='https://github.com/corpnewt/gibMacOS'>Third-party utilities</a> can be used to perform this on systems other than
macOS.
</p><!-- l. 619 --><p class='noindent'>For upgrade purposes, refer to the <span class='ec-lmtt-10'>Differences.pdf </span>document which provides information about changes to the configuration
(as compared to the previous release) as well as to the <span class='ec-lmtt-10'>Changelog.md </span>document (which contains a list of modifications across
all published updates).
</p><!-- l. 624 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='contribution'><span class='titlemark'>3.3   </span> <a id='x1-110003.3'></a>Contribution</h4>
<!-- l. 626 --><p class='noindent'>OpenCore can be compiled as a standard <a href='https://github.com/tianocore/tianocore.github.io/wiki/EDK-II'>EDK II</a> package and requires the <a href='https://github.com/tianocore/tianocore.github.io/wiki/EDK-II#stable-tags'>EDK II Stable</a> package. The currently supported
EDK II release is hosted in <a href='https://github.com/acidanthera/audk'>acidanthera/audk</a>. Required patches for this package can be found in the <span class='ec-lmtt-10'>Patches</span>
directory.
                                                                                                  
                                                                                                  
</p><!-- l. 634 --><p class='noindent'>When updating the LaTeX documentation (e.g. <span class='ec-lmtt-10'>Configuration.tex</span>) please do <span class='ec-lmri-10'>not </span>rebuild the PDF files till merging to
master happens. This avoids unnecessary merge conflicts: </p>
     <ul class='itemize1'>
     <li class='itemize'>External contributors using the pull-request approach should request the maintainers to handle the PDF rebuild
     in the pull-request message.
     </li>
     <li class='itemize'>Internal contributors should rebuild the documentation at merge time in the same or in a separate commit. One
     can ask another maintainer to rebuild the documentation when lacking the necessary tools in the pull-request
     message.</li></ul>
<!-- l. 647 --><p class='noindent'>The only officially supported toolchain is <span class='ec-lmtt-10'>XCODE5</span>. Other toolchains might work but are neither supported nor recommended.
Contributions of clean patches are welcome. Please do follow <a href='https://github.com/tianocore/tianocore.github.io/wiki/Code-Style-C'>EDK II C Codestyle</a>.
</p><!-- l. 652 --><p class='noindent'>To compile with <span class='ec-lmtt-10'>XCODE5</span>, besides <a href='https://developer.apple.com/xcode'>Xcode</a>, users should also install <a href='https://www.nasm.us'>NASM</a> and <a href='https://github.com/acidanthera/ocbuild/tree/master/external'>MTOC</a>. The latest Xcode version is recommended
for use despite the toolchain name. An example command sequence is as follows:
</p>
<!-- l. 658 -->
<p id='-compilation-commands'><a id='x1-11001r1'></a>
<a id='x1-11002'></a>
</p><pre class='lstlisting' id='listing-1'><span class='label'><a id='x1-11003r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>git</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>clone </span><span class='ec-lmtt-10'>--depth=1 </span><span class='ec-lmtt-10'>https://github.com/acidanthera/audk </span><span class='ec-lmtt-10'>UDK</span> 
</span><span class='label'><a id='x1-11004r2'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>cd</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>UDK</span> 
</span><span class='label'><a id='x1-11005r3'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>git</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>submodule </span><span class='ec-lmtt-10'>update </span><span class='ec-lmtt-10'>--init </span><span class='ec-lmtt-10'>--recommend-shallow</span> 
</span><span class='label'><a id='x1-11006r4'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>git</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>clone </span><span class='ec-lmtt-10'>--depth=1 </span><span class='ec-lmtt-10'>https://github.com/acidanthera/OpenCorePkg</span> 
</span><span class='label'><a id='x1-11007r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>.</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>./edksetup.sh</span> 
</span><span class='label'><a id='x1-11008r6'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>make</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-C </span><span class='ec-lmtt-10'>BaseTools</span> 
</span><span class='label'><a id='x1-11009r7'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>build</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-a </span><span class='ec-lmtt-10'>X64 </span><span class='ec-lmtt-10'>-b </span><span class='ec-lmtt-10'>RELEASE </span><span class='ec-lmtt-10'>-t </span><span class='ec-lmtt-10'>XCODE5 </span><span class='ec-lmtt-10'>-p </span><span class='ec-lmtt-10'>OpenCorePkg/OpenCorePkg.dsc</span></span></pre>
<figcaption class='caption'><span class='id'>Listing 1: </span><span class='content'>Compilation Commands</span></figcaption><!-- tex4ht:label?: x1-11009r3.3  -->
<!-- l. 668 --><p class='noindent'>For IDE usage Xcode projects are available in the root of the repositories. Another approach could be using <a href='https://microsoft.github.io/language-server-protocol'>Language Server
Protocols</a>. For example, <a href='https://www.sublimetext.com'>Sublime Text</a> with <a href='https://lsp.sublimetext.io'>LSP for Sublime Text</a> plugin. Add <span class='ec-lmtt-10'>compile_flags.txt </span>file with similar content to
the UDK root:
</p>
<!-- l. 673 -->
<p id='-ecc-configuration'><a id='x1-11010r2'></a>
<a id='x1-11011'></a>
</p><pre class='lstlisting' id='listing-2'><span class='label'><a id='x1-11012r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdePkg</span></span> 
<span class='label'><a id='x1-11013r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span> 
<span class='label'><a id='x1-11014r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>X64</span></span> 
<span class='label'><a id='x1-11015r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdeModulePkg</span></span> 
<span class='label'><a id='x1-11016r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdeModulePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span> 
<span class='label'><a id='x1-11017r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdeModulePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>X64</span></span> 
<span class='label'><a id='x1-11018r7'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>AMI</span></span> 
<span class='label'><a id='x1-11019r8'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Acidanthera</span></span> 
<span class='label'><a id='x1-11020r9'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Apple</span></span> 
<span class='label'><a id='x1-11021r10'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Apple</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>X64</span></span> 
<span class='label'><a id='x1-11022r11'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Duet</span></span> 
<span class='label'><a id='x1-11023r12'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Generic</span></span> 
<span class='label'><a id='x1-11024r13'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Intel</span></span> 
<span class='label'><a id='x1-11025r14'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Microsoft</span></span> 
<span class='label'><a id='x1-11026r15'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Nvidia</span></span> 
<span class='label'><a id='x1-11027r16'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OpenCorePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>VMware</span></span> 
<span class='label'><a id='x1-11028r17'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>OvmfPkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span> 
<span class='label'><a id='x1-11029r18'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>ShellPkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span> 
<span class='label'><a id='x1-11030r19'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>I</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>CpuPkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span> 
<span class='label'><a id='x1-11031r20'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>IInclude</span></span> 
<span class='label'><a id='x1-11032r21'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>include</span></span> 
<span class='label'><a id='x1-11033r22'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Packages</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>MdePkg</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Include</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Ue</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>.</span></span><span style='color:#000000'><span class='ec-lmtt-10'>h</span></span> 
<span class='label'><a id='x1-11034r23'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fshort</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>wchar</span></span> 
<span class='label'><a id='x1-11035r24'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wall</span></span> 
<span class='label'><a id='x1-11036r25'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wextra</span></span> 
<span class='label'><a id='x1-11037r26'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>unused</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>parameter</span></span> 
<span class='label'><a id='x1-11038r27'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>missing</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>braces</span></span> 
<span class='label'><a id='x1-11039r28'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>missing</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>fi</span></span><span style='color:#000000'><span class='ec-lmtt-10'>eld</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>initializers</span></span> 
<span class='label'><a id='x1-11040r29'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>tautological</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>compare</span></span> 
<span class='label'><a id='x1-11041r30'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>sign</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>compare</span></span> 
<span class='label'><a id='x1-11042r31'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>varargs</span></span> 
<span class='label'><a id='x1-11043r32'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Wno</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>unused</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>const</span></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>variable</span></span> 
<span class='label'><a id='x1-11044r33'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>DOC_TARGET_NOOPT</span></span><span style='color:#000000'><span class='ec-lmtt-10'>=1</span></span> 
<span class='label'><a id='x1-11045r34'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>-</span></span><span style='color:#000000'><span class='ec-lmtt-10'>DNO_MSABI_VA_FUNCS</span></span><span style='color:#000000'><span class='ec-lmtt-10'>=1</span></span></pre>
<figcaption class='caption'><span class='id'>Listing 2: </span><span class='content'>ECC Configuration</span></figcaption><!-- tex4ht:label?: x1-11045r3.3  -->
<!-- l. 710 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: <span class='ec-lmtt-10'>/UefiPackages </span>in the sample file denotes an absolute path.
</p><!-- l. 712 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: Tool developers modifying <span class='ec-lmtt-10'>config.plist </span>or any other OpenCore files must ensure that their tools check the
<span class='ec-lmtt-10'>opencore-version </span>NVRAM variable (see the <a href='#debug-properties'>Debug Properties</a> section below) and warn users if the version listed is
unsupported or prerelease. The OpenCore configuration may change across releases and such tools shall ensure that they
carefully follow this document. Failure to do so may result in such tools being considered to be malware and blocked by any
means.
</p><!-- l. 719 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='coding-conventions'><span class='titlemark'>3.4   </span> <a id='x1-120003.4'></a>Coding conventions</h4>
<!-- l. 721 --><p class='noindent'>As with any other project, we have conventions that we follow during development. All third-party contributors are advised to
adhere to the conventions listed below before submitting patches. To minimise abortive work and the potential rejection of
submissions, third-party contributors should initially raise issues to the <a href='https://github.com/acidanthera/bugtracker'>Acidanthera Bugtracker</a> for feedback before submitting
patches.
</p><!-- l. 728 --><p class='noindent'><span class='ec-lmbx-10'>Organisation</span>. The codebase is contained in the <span class='ec-lmtt-10'>OpenCorePkg </span>repository, which is the primary EDK II package.
</p>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'>Whenever changes are required in multiple repositories, separate pull requests should be sent to each.
     </li>
     <li class='itemize'>Committing the changes should happen firstly to dependent repositories, secondly to primary repositories to
     avoid automatic build errors.
     </li>
     <li class='itemize'>Each unique commit should compile with <span class='ec-lmtt-10'>XCODE5 </span>and preferably with other toolchains. In the majority of the
     cases it can be checked by accessing the <a href='https://travis-ci.com/acidanthera'>CI interface</a>. Ensuring that static analysis finds no warnings is preferred.
     </li>
     <li class='itemize'>External pull requests and tagged commits must be validated. That said, commits in master may build but may
     not necessarily work.
     </li>
     <li class='itemize'>Internal branches should be named as follows: <span class='ec-lmtt-10'>author-name-date</span>, e.g. <span class='ec-lmtt-10'>vit9696-ballooning-20191026</span>.
     </li>
     <li class='itemize'>Commit messages should be prefixed with the primary module (e.g. library or code module) the changes were
     made in. For example, <span class='ec-lmtt-10'>OcGuardLib: Add OC_ALIGNED macro</span>. For non-library changes <span class='ec-lmtt-10'>Docs </span>or <span class='ec-lmtt-10'>Build </span>prefixes
     are used.</li></ul>
<!-- l. 749 --><p class='noindent'><span class='ec-lmbx-10'>Design</span>. The codebase is written in a subset of freestanding C11 (C17) supported by most modern toolchains used by EDK II.
Applying common software development practices or requesting clarification is recommended if any particular case is not
discussed below. </p>
     <ul class='itemize1'>
     <li class='itemize'>Never rely on undefined behaviour and try to avoid implementation defined behaviour unless explicitly covered
     below (feel free to create an issue when a relevant case is not present).
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>OcGuardLib </span>to ensure safe integral arithmetics avoiding overflows. Unsigned wraparound should be relied
     on with care and reduced to the necessary amount.
     </li>
     <li class='itemize'>Check  pointers  for  correct  alignment  with  <span class='ec-lmtt-10'>OcGuardLib </span>and  do  not  rely  on  the  architecture  being  able  to
     dereference unaligned pointers.
     </li>
     <li class='itemize'>Use flexible array members instead of zero-length or one-length arrays where necessary.
     </li>
     <li class='itemize'>Use static assertions (<span class='ec-lmtt-10'>STATIC_ASSERT</span>) for type and value assumptions, and runtime assertions (<span class='ec-lmtt-10'>ASSERT</span>) for
     precondition and invariant sanity checking. Do not use runtime assertions to check for errors as they should never
     alter control flow and potentially be excluded.
     </li>
     <li class='itemize'>Assume <span class='ec-lmtt-10'>UINT32</span>/<span class='ec-lmtt-10'>INT32 </span>to be <span class='ec-lmtt-10'>int</span>-sized and use <span class='ec-lmtt-10'>%u</span>, <span class='ec-lmtt-10'>%d</span>, and <span class='ec-lmtt-10'>%x </span>to print them.
     </li>
     <li class='itemize'>Assume <span class='ec-lmtt-10'>UINTN</span>/<span class='ec-lmtt-10'>INTN </span>to be of unspecified size, and cast them to <span class='ec-lmtt-10'>UINT64</span>/<span class='ec-lmtt-10'>INT64 </span>for printing with <span class='ec-lmtt-10'>%Lu</span>, <span class='ec-lmtt-10'>%Ld </span>and so
     on as normal.
     </li>
     <li class='itemize'>Do   not   rely   on   integer   promotions   for   numeric   literals.   Use   explicit   casts   when   the   type   is
                                                                                                  
                                                                                                  
     implementation-dependent or suffixes when type size is known. Assume <span class='ec-lmtt-10'>U </span>for <span class='ec-lmtt-10'>UINT32 </span>and <span class='ec-lmtt-10'>ULL </span>for <span class='ec-lmtt-10'>UINT64</span>.
     </li>
     <li class='itemize'>Do ensure unsigned arithmetics especially in bitwise maths, shifts in particular.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>sizeof </span>operator should take variables instead of types where possible to be error prone. Use <span class='ec-lmtt-10'>ARRAY_SIZE </span>to
     obtain array size in elements. Use <span class='ec-lmtt-10'>L_STR_LEN </span>and <span class='ec-lmtt-10'>L_STR_SIZE </span>macros from <span class='ec-lmtt-10'>OcStringLib </span>to obtain string literal
     sizes to ensure compiler optimisation.
     </li>
     <li class='itemize'>Do not use <span class='ec-lmtt-10'>goto </span>keyword. Prefer early <span class='ec-lmtt-10'>return</span>, <span class='ec-lmtt-10'>break</span>, or <span class='ec-lmtt-10'>continue </span>after failing to pass error checking instead
     of nesting conditionals.
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>EFIAPI</span>, force UEFI calling convention, only in protocols, external callbacks between modules, and functions
     with variadic arguments.
     </li>
     <li class='itemize'>Provide inline documentation to every added function, at least describing its inputs, outputs, precondition,
     postcondition, and giving a brief description.
     </li>
     <li class='itemize'>Do not use <span class='ec-lmtt-10'>RETURN_STATUS</span>. Assume <span class='ec-lmtt-10'>EFI_STATUS </span>to be a matching superset that is to be always used when
     <span class='ec-lmtt-10'>BOOLEAN </span>is not enough.
     </li>
     <li class='itemize'>Security violations should halt the system or cause a forced reboot.</li></ul>
<!-- l. 787 --><p class='noindent'><span class='ec-lmbx-10'>Codestyle</span>. The codebase follows the <a href='https://github.com/tianocore/tianocore.github.io/wiki/Code-Style-C'>EDK II codestyle</a> with a few changes and clarifications. </p>
     <ul class='itemize1'>
     <li class='itemize'>Write inline documentation for the functions and variables only once: in headers, where a header prototype is
     available, and inline for <span class='ec-lmtt-10'>static </span>variables and functions.
     </li>
     <li class='itemize'>Use line length of 120 characters or less, preferably 100 characters.
     </li>
     <li class='itemize'>Use spaces after casts, e.g. <span class='ec-lmtt-10'>(VOID *)(UINTN) Variable</span>.
     </li>
     <li class='itemize'>Use two spaces to indent function arguments when splitting lines.
     </li>
     <li class='itemize'>Prefix public functions with either <span class='ec-lmtt-10'>Oc </span>or another distinct name.
     </li>
     <li class='itemize'>Do not prefix private <span class='ec-lmtt-10'>static </span>functions, but prefix private <span class='ec-lmtt-10'>non-static </span>functions with <span class='ec-lmtt-10'>Internal</span>.
     </li>
     <li class='itemize'>Use SPDX license headers as shown in <a href='https://github.com/acidanthera/bugtracker/issues/483'>acidanthera/bugtracker#483</a>.</li></ul>
<!-- l. 803 --><p class='noindent'>
</p>
                                                                                                  
                                                                                                  
<h4 class='subsectionHead' id='debugging'><span class='titlemark'>3.5   </span> <a id='x1-130003.5'></a>Debugging</h4>
<!-- l. 805 --><p class='noindent'>The codebase incorporates EDK II debugging and few custom features to improve the experience. </p>
     <ul class='itemize1'>
     <li class='itemize'>Use module prefixes, 2-5 letters followed by a colon (<span class='ec-lmtt-10'>:</span>), for debug messages. For <span class='ec-lmtt-10'>OpenCorePkg </span>use <span class='ec-lmtt-10'>OC:</span>, for
     libraries and drivers use their own unique prefixes.
     </li>
     <li class='itemize'>Do not use dots (<span class='ec-lmtt-10'>.</span>) in the end of debug messages and separate <span class='ec-lmtt-10'>EFI_STATUS</span>, printed by <span class='ec-lmtt-10'>%r</span>, with a hyphen (e.g.
     <span class='ec-lmtt-10'>OCRAM: Allocation of %u bytes failed - %r\n</span>).
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>DEBUG_CODE_BEGIN () </span>and <span class='ec-lmtt-10'>DEBUG_CODE_END () </span>constructions to guard debug checks that may potentially
     reduce the performance of release builds and are otherwise unnecessary.
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>DEBUG </span>macro to print debug messages during normal functioning, and <span class='ec-lmtt-10'>RUNTIME_DEBUG </span>for debugging after
     <span class='ec-lmtt-10'>EXIT_BOOT_SERVICES</span>.
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>DEBUG_VERBOSE </span>debug level to leave debug messages for future debugging of the code, which are currently
     not necessary. By default <span class='ec-lmtt-10'>DEBUG_VERBOSE </span>messages are ignored even in <span class='ec-lmtt-10'>DEBUG </span>builds.
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>DEBUG_INFO </span>debug level for all non critical messages (including errors) and <span class='ec-lmtt-10'>DEBUG_BULK_INFO </span>for extensive
     messages that should not appear in NVRAM log that is heavily limited in size. These messages are ignored in
     <span class='ec-lmtt-10'>RELEASE </span>builds.
     </li>
     <li class='itemize'>Use <span class='ec-lmtt-10'>DEBUG_ERROR </span>to print critical human visible messages that may potentially halt the boot process, and
     <span class='ec-lmtt-10'>DEBUG_WARN </span>for all other human visible errors, <span class='ec-lmtt-10'>RELEASE </span>builds included.</li></ul>
<!-- l. 826 --><p class='noindent'>The <a href='https://git-scm.com/docs/git-bisect'><span class='ec-lmtt-10'>git-bisect</span></a> functionality may be useful when trying to find problematic changes. Unofficial sources of <span class='ec-lmtt-10'>per-commit</span>
OpenCore binary builds, such as <a href='https://dortania.github.io/builds'>Dortania</a>, may also be useful.
</p><!-- l. 830 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='acpi'><span class='titlemark'>4   </span> <a id='x1-140004'></a>ACPI</h3>
<!-- l. 832 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction1'><span class='titlemark'>4.1   </span> <a id='x1-150004.1'></a>Introduction</h4>
<!-- l. 834 --><p class='noindent'>ACPI (Advanced Configuration and Power Interface) is an open standard to discover and configure computer hardware. The
<a href='https://uefi.org/specifications'>ACPI specification</a> defines standard tables (e.g. <span class='ec-lmtt-10'>DSDT</span>, <span class='ec-lmtt-10'>SSDT</span>, <span class='ec-lmtt-10'>FACS</span>, <span class='ec-lmtt-10'>DMAR</span>) and various methods (e.g. <span class='ec-lmtt-10'>_DSM</span>, <span class='ec-lmtt-10'>_PRW</span>) for
implementation. Modern hardware needs few changes to maintain ACPI compatibility and some options for such changes are
provided as part of OpenCore.
</p><!-- l. 842 --><p class='noindent'>To compile and disassemble ACPI tables, the <a href='https://github.com/acpica/acpica'>iASL compiler</a> developed by <a href='https://www.acpica.org'>ACPICA</a> can be used. A GUI front-end to iASL
compiler can be downloaded from <a href='https://github.com/acidanthera/MaciASL/releases'>Acidanthera/MaciASL</a>.
</p><!-- l. 846 --><p class='noindent'>ACPI changes apply globally (to every operating system) with the following effective order:
</p>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>Patch </span>is processed.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Delete </span>is processed.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Add </span>is processed.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Quirks </span>are processed.</li></ul>
<!-- l. 856 --><p class='noindent'>Applying the changes globally resolves the problems of incorrect operating system detection (consistent with the ACPI
specification, not possible before the operating system boots), operating system chainloading, and difficult ACPI debugging.
Hence, more attention may be required when writing changes to <span class='ec-lmtt-10'>_OSI</span>.
</p><!-- l. 861 --><p class='noindent'>Applying the patches early makes it possible to write so called “proxy” patches, where the original method is patched in the
original table and is implemented in the patched table.
</p><!-- l. 865 --><p class='noindent'>There are several sources of ACPI tables and workarounds. Commonly used ACPI tables are provided with OpenCore,
VirtualSMC, VoodooPS2, and WhateverGreen releases. Besides those, several third-party instructions may be found on the
AppleLife <a href='https://applelife.ru/forums/xakintosh.67'>Laboratory</a> and <a href='https://applelife.ru/forums/dsdt.129'>DSDT</a> subforums (e.g. <a href='https://applelife.ru/posts/498967'>Battery register splitting</a> guide). A slightly more user-friendly explanation of
some tables included with OpenCore can also be found in <a href='https://dortania.github.io'>Dortania</a>’s <a href='https://dortania.github.io/Getting-Started-With-ACPI'>Getting started with ACPI</a> guide. For more
exotic cases, there are several alternatives such as <a href='https://github.com/daliansky'>daliansky</a>’s <a href='https://github.com/daliansky/OC-little'>ACPI sample collection</a> (<a href='https://github.com/5T33Z0/OC-Little-Translated'>English Translation by
5T33Z0 et al</a>). Please note however, that suggested solutions from third parties may be outdated or may contain
errors.
</p><!-- l. 880 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties'><span class='titlemark'>4.2   </span> <a id='x1-160004.2'></a>Properties</h4>
<!-- l. 882 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-16002x1'>
     <!-- l. 884 --><p class='noindent'><span class='ec-lmtt-10'>Add</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load selected tables from the <span class='ec-lmtt-10'>OC/ACPI </span>directory.
     </p><!-- l. 890 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each add entry. Refer to the <a href='#add-properties'>Add Properties</a> section below for
     details.
     </p></li>
<li class='enumerate' id='x1-16004x2'>
     <!-- l. 894 --><p class='noindent'><span class='ec-lmtt-10'>Delete</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Remove selected tables from the ACPI stack.
     </p><!-- l. 899 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each delete entry. Refer to the <a href='#delete-properties'>Delete Properties</a> section below
     for details.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-16006x3'>
     <!-- l. 903 --><p class='noindent'><span class='ec-lmtt-10'>Patch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform binary patches in ACPI tables before table addition or removal.
     </p><!-- l. 909 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dictionary </span>values describing each patch entry. Refer to the <a href='#patch-properties'>Patch Properties</a> section
     below for details.
     </p></li>
<li class='enumerate' id='x1-16008x4'><span class='ec-lmtt-10'>Quirks</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual ACPI quirks described in the <a href='#quirks-properties'>Quirks Properties</a> section below.
</li></ol>
<!-- l. 920 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='add-properties'><span class='titlemark'>4.3   </span> <a id='x1-170004.3'></a>Add Properties</h4>
<!-- l. 922 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-17002x1'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-17004x2'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to add this ACPI table.
     </li>
<li class='enumerate' id='x1-17006x3'>
     <!-- l. 937 --><p class='noindent'><span class='ec-lmtt-10'>Path</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>:   File   paths   meant   to   be   loaded   as   ACPI   tables.   Example   values   include   <span class='ec-lmtt-10'>DSDT.aml</span>,
     <span class='ec-lmtt-10'>SubDir/SSDT-8.aml</span>, <span class='ec-lmtt-10'>SSDT-USBX.aml</span>, etc.
     </p><!-- l. 944 --><p class='noindent'>The ACPI table load order follows the item order in the array. ACPI tables are loaded from the <span class='ec-lmtt-10'>OC/ACPI </span>directory.
     </p><!-- l. 947 --><p class='noindent'><span class='ec-lmbx-10'>Note</span>: All tables apart from tables with a <span class='ec-lmtt-10'>DSDT </span>table identifier (determined by parsing data, not by filename)
     insert new tables into the ACPI stack. <span class='ec-lmtt-10'>DSDT </span>tables perform a replacement of DSDT tables instead.
                                                                                                  
                                                                                                  
</p>
     </li></ol>
<!-- l. 953 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='delete-properties'><span class='titlemark'>4.4   </span> <a id='x1-180004.4'></a>Delete Properties</h4>
<!-- l. 955 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-18002x1'><span class='ec-lmtt-10'>All</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false </span>(Only delete the first matched table)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to delete all ACPI tables matching the condition.
     </li>
<li class='enumerate' id='x1-18004x2'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-18006x3'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to remove this ACPI table.
     </li>
<li class='enumerate' id='x1-18008x4'><span class='ec-lmtt-10'>OemTableId</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero (Match any table OEM ID)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table OEM ID equal to this value.
     </li>
<li class='enumerate' id='x1-18010x5'><span class='ec-lmtt-10'>TableLength</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Match any table size)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table size equal to this value.
     </li>
<li class='enumerate' id='x1-18012x6'>
     <!-- l. 989 --><p class='noindent'><span class='ec-lmtt-10'>TableSignature</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 4 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero (Match any table signature)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table signature equal to this value.
     </p><!-- l. 994 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Do not use table signatures when the sequence must be replaced in multiple places. This is particularly
     relevant when performing different types of renames.
</p>
     </li></ol>
<!-- l. 1000 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='patch-properties'><span class='titlemark'>4.5   </span> <a id='x1-190004.5'></a>Patch Properties</h4>
<!-- l. 1002 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-19002x1'>
     <!-- l. 1005 --><p class='noindent'><span class='ec-lmtt-10'>Base</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Selects ACPI path base for patch lookup (or immediate replacement) by obtaining the offset to
     the provided path.
     </p><!-- l. 1011 --><p class='noindent'>Only fully-qualified absolute paths are supported (e.g. <span class='ec-lmtt-10'>\_SB.PCI0.LPCB.HPET</span>). Currently supported object types
     are: <span class='ec-lmtt-10'>Device</span>, <span class='ec-lmtt-10'>Field</span>, <span class='ec-lmtt-10'>Method</span>.
     </p><!-- l. 1014 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Use with care, not all OEM tables can be parsed. Use <span class='ec-lmtt-10'>ACPIe </span>utility to debug. <span class='ec-lmtt-10'>ACPIe </span>compiled with <span class='ec-lmtt-10'>DEBUG=1
     </span><span class='ec-lmtt-10'>make </span>command produces helpful ACPI lookup tracing.
     </p></li>
<li class='enumerate' id='x1-19004x2'><span class='ec-lmtt-10'>BaseSkip</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Do not skip any occurrences)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of found <span class='ec-lmtt-10'>Base </span>occurrences to skip before finds and replacements are applied.
     </li>
<li class='enumerate' id='x1-19006x3'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-19008x4'><span class='ec-lmtt-10'>Count</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Apply patch to all occurrences found)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of occurrences to patch.
     </li>
<li class='enumerate' id='x1-19010x5'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to apply this ACPI patch.
     </li>
<li class='enumerate' id='x1-19012x6'>
     <!-- l. 1045 --><p class='noindent'><span class='ec-lmtt-10'>Find</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data to find. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </p><!-- l. 1050 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Can be empty, when <span class='ec-lmtt-10'>Base </span>is specified, immediate replacement after <span class='ec-lmtt-10'>Base </span>lookup happens in this case.
     </p></li>
<li class='enumerate' id='x1-19014x7'><span class='ec-lmtt-10'>Limit</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Search entire ACPI table)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Maximum number of bytes to search for.
     </li>
<li class='enumerate' id='x1-19016x8'><span class='ec-lmtt-10'>Mask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during find comparison. Allows fuzzy search by ignoring not masked (set
     to zero) bits. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-19018x9'><span class='ec-lmtt-10'>OemTableId</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero (Match any table OEM ID)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table OEM ID equal to this value.
     </li>
<li class='enumerate' id='x1-19020x10'><span class='ec-lmtt-10'>Replace</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replacement data of one or more bytes.
     </li>
<li class='enumerate' id='x1-19022x11'><span class='ec-lmtt-10'>ReplaceMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during replacement. Allows fuzzy replacement by updating masked (set
     to non-zero) bits. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-19024x12'><span class='ec-lmtt-10'>Skip</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Do not skip any occurrences)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of found occurrences to skip before replacements are applied.
     </li>
<li class='enumerate' id='x1-19026x13'><span class='ec-lmtt-10'>TableLength</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Match any table size)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table size equal to this value.
     </li>
<li class='enumerate' id='x1-19028x14'><span class='ec-lmtt-10'>TableSignature</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 4 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero (Match any table signature)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Match table signature equal to this value.
</li></ol>
<!-- l. 1108 --><p class='noindent'>In most cases, ACPI patches are not useful and are harmful:
</p>
     <ul class='itemize1'>
     <li class='itemize'>Avoid renaming devices with ACPI patches. This may fail or perform improper renaming of unrelated devices
     (e.g. <span class='ec-lmtt-10'>EC </span>and <span class='ec-lmtt-10'>EC0</span>), be unnecessary, or even fail to rename devices in certain tables. For ACPI consistency it is
     much safer to rename devices at the I/O Registry level, as done by <a href='https://github.com/acidanthera/WhateverGreen'>WhateverGreen</a>.
     </li>
     <li class='itemize'>Avoid patching <span class='ec-lmtt-10'>_OSI </span>to support a higher feature set level whenever possible. While this enables a number of
     workarounds on APTIO firmware, it typically results in a need for additional patches. These are not usually
     needed on modern firmware and smaller patches work well on firmware that does. However, laptop vendors
     often rely on this method to determine the availability of functions such as modern I2C input support, thermal
     adjustment and custom feature additions.
     </li>
     <li class='itemize'>Avoid patching embedded controller event <span class='ec-lmtt-10'>_Qxx </span>just to enable brightness keys. The conventional process to find
     these keys typically involves significant modifications to DSDT and SSDT files and in addition, the debug kext
     is not stable on newer systems. Please use the built-in brightness key discovery in <a href='https://github.com/acidanthera/BrightnessKeys'>BrightnessKeys</a> instead.
     </li>
     <li class='itemize'>Avoid making ad hoc changes such as renaming <span class='ec-lmtt-10'>_PRW </span>or <span class='ec-lmtt-10'>_DSM </span>whenever possible.</li></ul>
<!-- l. 1137 --><p class='noindent'>Some cases where patching is actually useful include:
</p>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'>Refreshing <span class='ec-lmtt-10'>HPET </span>(or another device) method header to avoid compatibility checks by <span class='ec-lmtt-10'>_OSI </span>on legacy hardware.
     <span class='ec-lmtt-10'>_STA </span>method  with  <span class='ec-lmtt-10'>if ((OSFL () == Zero)) { If (HPTE) ... Return (Zero) </span>content  may  be  forced  to
     always return 0xF by replacing <span class='ec-lmtt-10'>A0 10 93 4F 53 46 4C 00 </span>with <span class='ec-lmtt-10'>A4 0A 0F A3 A3 A3 A3 A3</span>.
     </li>
     <li class='itemize'>To provide a custom method implementation within an SSDT, to inject shutdown fixes on certain computers for
     instance, the original method can be replaced with a dummy name by patching <span class='ec-lmtt-10'>_PTS </span>with <span class='ec-lmtt-10'>ZPTS </span>and adding a
     callback to the original method.</li></ul>
<!-- l. 1153 --><p class='noindent'>The Tianocore <a href='https://github.com/acidanthera/audk/blob/master/MdePkg/Include/IndustryStandard/AcpiAml.h'>AcpiAml.h</a> source file may help with better understanding ACPI opcodes.
</p><!-- l. 1155 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Patches of different <span class='ec-lmtt-10'>Find </span>and <span class='ec-lmtt-10'>Replace </span>lengths are unsupported as they may corrupt ACPI tables and make the system
unstable due to area relocation. If such changes are needed, the utilisation of “proxy” patching or the padding of <span class='ec-lmtt-10'>NOP </span>to the
remaining area could be considered.
</p><!-- l. 1160 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='quirks-properties'><span class='titlemark'>4.6   </span> <a id='x1-200004.6'></a>Quirks Properties</h4>
<!-- l. 1162 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-20002x1'>
     <!-- l. 1165 --><p class='noindent'><span class='ec-lmtt-10'>FadtEnableReset</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide reset register and flag in FADT table to enable reboot and shutdown.
     </p><!-- l. 1171 --><p class='noindent'>Mainly  required  on  legacy  hardware  and  a  few  newer  laptops.  Can  also  fix  power-button  shortcuts.  Not
     recommended unless required.
     </p></li>
<li class='enumerate' id='x1-20004x2'><span class='ec-lmtt-10'>NormalizeHeaders</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Cleanup ACPI header fields to workaround macOS ACPI implementation flaws that result in boot
     crashes. Reference: <a href='https://alextjam.es/debugging-appleacpiplatform/'>Debugging AppleACPIPlatform on 10.13</a> by Alex James (also known as theracermaster). The
     issue was fixed in macOS Mojave (10.14).
     </li>
<li class='enumerate' id='x1-20006x3'>
     <!-- l. 1185 --><p class='noindent'><span class='ec-lmtt-10'>RebaseRegions</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Attempt to heuristically relocate ACPI memory regions. Not recommended.
     </p><!-- l. 1191 --><p class='noindent'>ACPI  tables  are  often  generated  dynamically  by  the  underlying  firmware  implementation.  Among  the
     position-independent code, ACPI tables may contain the physical addresses of MMIO areas used for device
     configuration, typically grouped by region (e.g. <span class='ec-lmtt-10'>OperationRegion</span>). Changing firmware settings or hardware
     configuration, upgrading or patching the firmware inevitably leads to changes in dynamically generated ACPI
                                                                                                  
                                                                                                  
     code, which sometimes results in the shift of the addresses in the aforementioned <span class='ec-lmtt-10'>OperationRegion </span>constructions.
     </p><!-- l. 1201 --><p class='noindent'>For this reason, the application of modifications to ACPI tables is extremely risky. The best approach is to make
     as few changes as possible to ACPI tables and to avoid replacing any tables, particularly DSDT tables. When
     this cannot be avoided, ensure that any custom DSDT tables are based on the most recent DSDT tables or
     attempt to remove reads and writes for the affected areas.
     </p><!-- l. 1207 --><p class='noindent'>When nothing else helps, this option could be tried to avoid stalls at <span class='ec-lmtt-10'>PCI Configuration Begin </span>phase of macOS
     booting by attempting to fix the ACPI addresses. It is not a magic bullet however, and only works with the most
     typical cases. Do not use unless absolutely required as it can have the opposite effect on certain platforms and
     result in boot failures.
     </p></li>
<li class='enumerate' id='x1-20008x4'>
     <!-- l. 1214 --><p class='noindent'><span class='ec-lmtt-10'>ResetHwSig</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reset <span class='ec-lmtt-10'>FACS </span>table <span class='ec-lmtt-10'>HardwareSignature </span>value to <span class='ec-lmtt-10'>0</span>.
     </p><!-- l. 1220 --><p class='noindent'>This works around firmware that fail to maintain hardware signature across the reboots and cause issues with
     waking from hibernation.
     </p></li>
<li class='enumerate' id='x1-20010x5'>
     <!-- l. 1224 --><p class='noindent'><span class='ec-lmtt-10'>ResetLogoStatus</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reset <span class='ec-lmtt-10'>BGRT </span>table <span class='ec-lmtt-10'>Displayed </span>status field to <span class='ec-lmtt-10'>false</span>.
     </p><!-- l. 1230 --><p class='noindent'>This works around firmware that provide a <span class='ec-lmtt-10'>BGRT </span>table but fail to handle screen updates afterwards.
     </p></li>
<li class='enumerate' id='x1-20012x6'>
     <!-- l. 1234 --><p class='noindent'><span class='ec-lmtt-10'>SyncTableIds</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sync table identifiers with the <span class='ec-lmtt-10'>SLIC </span>table.
     </p><!-- l. 1239 --><p class='noindent'>This works around patched tables becoming incompatible with the <span class='ec-lmtt-10'>SLIC </span>table causing licensing issues in older
     Windows operating systems.
</p>
     </li></ol>
<!-- l. 1245 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='booter'><span class='titlemark'>5   </span> <a id='x1-210005'></a>Booter</h3>
<!-- l. 1247 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction2'><span class='titlemark'>5.1   </span> <a id='x1-220005.1'></a>Introduction</h4>
<!-- l. 1249 --><p class='noindent'>This section allows the application of different types of UEFI modifications to operating system bootloaders, primarily the
                                                                                                  
                                                                                                  
Apple bootloader (<span class='ec-lmtt-10'>boot.efi</span>). The modifications currently provide various patches and environment alterations for different
firmware types. Some of these features were originally implemented as part of <a href='https://github.com/acidanthera/AptioFixPkg'>AptioMemoryFix.efi</a>, which is no longer
maintained. Refer to the <a href='#tips-and-tricks'>Tips and Tricks</a> section for instructions on migration.
</p><!-- l. 1257 --><p class='noindent'>If this is used for the first time on customised firmware, the following requirements should be met before starting:
</p>
     <ul class='itemize1'>
     <li class='itemize'>Most up-to-date UEFI firmware (check the motherboard vendor website).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Fast Boot </span>and <span class='ec-lmtt-10'>Hardware Fast Boot </span>disabled in firmware settings if present.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Above 4G Decoding </span>or  similar  enabled  in  firmware  settings  if  present.  Note  that  on  some  motherboards,
     notably the ASUS WS-X299-PRO, this option results in adverse effects and must be disabled. While no other
     motherboards with the same issue are known, this option should be checked first whenever erratic boot failures
     are encountered.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>DisableIoMapper </span>quirk enabled, or <span class='ec-lmtt-10'>VT-d </span>disabled in firmware settings if present, or ACPI DMAR table deleted.
     </li>
     <li class='itemize'><span class='ec-lmbx-10'>No </span>‘slide‘ boot argument present in NVRAM or anywhere else. It is not necessary unless the system cannot be
     booted at all or <span class='ec-lmtt-10'>No slide values are usable! Use custom slide! </span>message can be seen in the log.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>CFG Lock </span>(MSR <span class='ec-lmtt-10'>0xE2 </span>write protection) disabled in firmware settings if present. Refer to the <a href='#quirks-properties2'>ControlMsrE2</a> notes
     for details.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>CSM </span>(Compatibility Support Module) disabled in firmware settings if present. On NVIDIA 6xx/AMD 2xx or
     older, GOP ROM may have to be flashed first. Use <a href='https://www.win-raid.com/t892f16-AMD-and-Nvidia-GOP-update-No-requests-DIY.html'>GopUpdate</a> (see the second post) or <a href='http://www.insanelymac.com/forum/topic/299614-asus-eah6450-video-bios-uefi-gop-upgrade-and-gop-uefi-binary-in-efi-for-many-ati-cards/page-1#entry2042163'>AMD UEFI GOP
     MAKER</a> in case of any potential confusion.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>EHCI/XHCI Hand-off </span>enabled in firmware settings <span class='ec-lmtt-10'>only </span>if boot stalls unless USB devices are disconnected.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>VT-x</span>, <span class='ec-lmtt-10'>Hyper Threading</span>, <span class='ec-lmtt-10'>Execute Disable Bit </span>enabled in firmware settings if present.
     </li>
     <li class='itemize'>While it may not be required, sometimes <span class='ec-lmtt-10'>Thunderbolt support</span>, <span class='ec-lmtt-10'>Intel SGX</span>, and <span class='ec-lmtt-10'>Intel Platform Trust </span>may
     have to be disabled in firmware settings present.</li></ul>
<!-- l. 1292 --><p class='noindent'>When debugging sleep issues, Power Nap and automatic power off (which appear to sometimes cause wake to black screen or
boot loop issues on older platforms) may be temporarily disabled. The specific issues may vary, but ACPI tables should
typically be looked at first.
</p><!-- l. 1296 --><p class='noindent'>Here is an example of a defect found on some <a href='http://www.insanelymac.com/forum/topic/329624-need-cmos-reset-after-sleep-only-after-login/#entry2534645'>Z68 motherboards</a>. To turn Power Nap and the others off, run the following
commands in Terminal: </p><!-- l. 1299 -->
<pre class='lstlisting' id='listing-3'><span class='label'><a id='x1-22001r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>sudo</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>pmset </span><span class='ec-lmtt-10'>autopoweroff </span><span class='ec-lmtt-10'>0</span> 
</span><span class='label'><a id='x1-22002r2'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>sudo</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>pmset </span><span class='ec-lmtt-10'>powernap </span><span class='ec-lmtt-10'>0</span> 
</span><span class='label'><a id='x1-22003r3'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>sudo</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>pmset </span><span class='ec-lmtt-10'>standby </span><span class='ec-lmtt-10'>0</span></span></pre>
<!-- l. 1305 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: These settings may be reset by hardware changes and in certain other circumstances. To view their current state, use the
<span class='ec-lmtt-10'>pmset -g </span>command in Terminal.
                                                                                                  
                                                                                                  
</p><!-- l. 1308 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties1'><span class='titlemark'>5.2   </span> <a id='x1-230005.2'></a>Properties</h4>
<!-- l. 1310 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-23002x1'><span class='ec-lmtt-10'>MmioWhitelist</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  To  be  filled  with  <span class='ec-lmtt-10'>plist dict </span>values,  describing  addresses  critical  for  particular  firmware
     functioning when <span class='ec-lmtt-10'>DevirtualiseMmio </span>quirk is in use. Refer to the <a href='#mmiowhitelist-properties'>MmioWhitelist Properties</a> section below for
     details.
     </li>
<li class='enumerate' id='x1-23004x2'>
     <!-- l. 1322 --><p class='noindent'><span class='ec-lmtt-10'>Patch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform binary patches in booter.
     </p><!-- l. 1327 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dictionary </span>values, describing each patch. Refer to the <a href='#patch-properties1'>Patch Properties</a> section below
     for details.
     </p></li>
<li class='enumerate' id='x1-23006x3'><span class='ec-lmtt-10'>Quirks</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual booter quirks described in the <a href='#quirks-properties1'>Quirks Properties</a> section below.
</li></ol>
<!-- l. 1338 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='mmiowhitelist-properties'><span class='titlemark'>5.3   </span> <a id='x1-240005.3'></a>MmioWhitelist Properties</h4>
<!-- l. 1340 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-24002x1'>
     <!-- l. 1343 --><p class='noindent'><span class='ec-lmtt-10'>Address</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Exceptional MMIO address, which memory descriptor should be left virtualised (unchanged) by
     <span class='ec-lmtt-10'>DevirtualiseMmio</span>. This means that the firmware will be able to directly communicate with this memory region
     during operating system functioning, because the region this value is in will be assigned a virtual address.
     </p><!-- l. 1351 --><p class='noindent'>The  addresses  written  here  must  be  part  of  the  memory  map,  have  <span class='ec-lmtt-10'>EfiMemoryMappedIO </span>type  and
     <span class='ec-lmtt-10'>EFI_MEMORY_RUNTIME </span>attribute (highest bit) set. The debug log can be used to find the list of the candidates.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-24004x2'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-24006x3'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Exclude MMIO address from the devirtualisation procedure.
</li></ol>
<!-- l. 1370 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='patch-properties1'><span class='titlemark'>5.4   </span> <a id='x1-250005.4'></a>Patch Properties</h4>
<!-- l. 1372 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-25002x1'><span class='ec-lmtt-10'>Arch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Apply to any supported architecture)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Booter patch architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>x86_64</span>).
     </li>
<li class='enumerate' id='x1-25004x2'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-25006x3'><span class='ec-lmtt-10'>Count</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Apply to all occurrences found)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of patch occurrences to apply.
     </li>
<li class='enumerate' id='x1-25008x4'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to activate this booter patch.
     </li>
<li class='enumerate' id='x1-25010x5'><span class='ec-lmtt-10'>Find</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data to find. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-25012x6'><span class='ec-lmtt-10'>Identifier</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Match any booter)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: <span class='ec-lmtt-10'>Apple </span>for macOS booter (typically <span class='ec-lmtt-10'>boot.efi</span>); or a name with a suffix, such as <span class='ec-lmtt-10'>bootmgfw.efi</span>,
     for a specific booter.
     </li>
<li class='enumerate' id='x1-25014x7'><span class='ec-lmtt-10'>Limit</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Search the entire booter)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Maximum number of bytes to search for.
     </li>
<li class='enumerate' id='x1-25016x8'><span class='ec-lmtt-10'>Mask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during find comparison. Allows fuzzy search by ignoring not masked (set
     to zero) bits. Must be equal to <span class='ec-lmtt-10'>Find </span>in size if set.
     </li>
<li class='enumerate' id='x1-25018x9'><span class='ec-lmtt-10'>Replace</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replacement data of one or more bytes.
     </li>
<li class='enumerate' id='x1-25020x10'><span class='ec-lmtt-10'>ReplaceMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during replacement. Allows fuzzy replacement by updating masked (set
     to non-zero) bits. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-25022x11'><span class='ec-lmtt-10'>Skip</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Do not skip any occurrences)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of found occurrences to skip before replacements are applied.
</li></ol>
<!-- l. 1448 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='quirks-properties1'><span class='titlemark'>5.5   </span> <a id='x1-260005.5'></a>Quirks Properties</h4>
<!-- l. 1450 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-26002x1'>
     <!-- l. 1453 --><p class='noindent'><span class='ec-lmtt-10'>AllowRelocationBlock</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Allows booting macOS through a relocation block.
     </p><!-- l. 1458 --><p class='noindent'>The relocation block is a scratch buffer allocated in the lower 4 GB used for loading the kernel and related
     structures  by  EfiBoot  on  firmware  where  the  lower  memory  region  is  otherwise  occupied  by  (assumed)
     non-runtime data. Right before kernel startup, the relocation block is copied back to lower addresses. Similarly,
     all the other addresses pointing to the relocation block are also carefully adjusted. The relocation block can be
     used when:
</p>
         <ul class='itemize1'>
         <li class='itemize'>No better slide exists (all the memory is used)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>slide=0 </span>is forced (by an argument or safe mode)
         </li>
         <li class='itemize'>KASLR (slide) is unsupported (this is macOS 10.7 or older)</li></ul>
     <!-- l. 1472 --><p class='noindent'>This quirk requires <span class='ec-lmtt-10'>ProvideCustomSlide </span>to be enabled and typically also requires enabling <span class='ec-lmtt-10'>AvoidRuntimeDefrag </span>to
     function correctly. Hibernation is not supported when booting with a relocation block, which will only be used if required
     when the quirk is enabled.
     </p><!-- l. 1477 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: While this quirk is required to run older macOS versions on platforms with used lower memory, it is
     not compatible with some hardware and macOS 11. In such cases, consider using <span class='ec-lmtt-10'>EnableSafeModeSlide</span>
     instead.
     </p></li>
<li class='enumerate' id='x1-26004x2'>
     <!-- l. 1483 --><p class='noindent'><span class='ec-lmtt-10'>AvoidRuntimeDefrag</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Protect from boot.efi runtime memory defragmentation.
     </p><!-- l. 1488 --><p class='noindent'>This option fixes UEFI runtime services (date, time, NVRAM, power control, etc.) support on firmware that uses SMM
     backing for certain services such as variable storage. SMM may try to access memory by physical addresses in non-SMM
                                                                                                  
                                                                                                  
     areas but this may sometimes have been moved by boot.efi. This option prevents boot.efi from moving such
     data.
     </p><!-- l. 1494 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Most types of firmware, apart from Apple and VMware, need this quirk.
     </p></li>
<li class='enumerate' id='x1-26006x3'>
     <!-- l. 1497 --><p class='noindent'><span class='ec-lmtt-10'>DevirtualiseMmio</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Remove runtime attribute from certain MMIO regions.
     </p><!-- l. 1502 --><p class='noindent'>This quirk reduces the stolen memory footprint in the memory map by removing the runtime bit for known memory
     regions. This quirk may result in an increase of KASLR slides available but without additional measures, it is not
     necessarily compatible with the target board. This quirk typically frees between 64 and 256 megabytes of memory,
     present in the debug log, and on some platforms, is the only way to boot macOS, which otherwise fails with allocation
     errors at the bootloader stage.
     </p><!-- l. 1509 --><p class='noindent'>This option is useful on all types of firmware, except for some very old ones such as Sandy Bridge. On certain firmware, a
     list of addresses that need virtual addresses for proper NVRAM and hibernation functionality may be required. Use the
     <span class='ec-lmtt-10'>MmioWhitelist </span>section for this.
     </p></li>
<li class='enumerate' id='x1-26008x4'>
     <!-- l. 1515 --><p class='noindent'><span class='ec-lmtt-10'>DisableSingleUser</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disable single user mode.
     </p><!-- l. 1520 --><p class='noindent'>This is a security option that restricts the activation of single user mode by ignoring the <span class='ec-lmtt-10'>CMD+S </span>hotkey and the <span class='ec-lmtt-10'>-s </span>boot
     argument. The behaviour with this quirk enabled is supposed to match T2-based model behaviour. Refer to this <a href='https://web.archive.org/web/20200517125051/https://support.apple.com/en-us/HT201573'>archived
     article</a> to understand how to use single user mode with this quirk enabled.
     </p></li>
<li class='enumerate' id='x1-26010x5'>
     <!-- l. 1528 --><p class='noindent'><span class='ec-lmtt-10'>DisableVariableWrite</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Protect from macOS NVRAM write access.
     </p><!-- l. 1533 --><p class='noindent'>This is a security option that restricts NVRAM access in macOS. This quirk requires <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol
     implemented in <span class='ec-lmtt-10'>OpenRuntime.efi</span>.
     </p><!-- l. 1537 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This quirk can also be used as an ad hoc workaround for defective UEFI runtime services implementations that are
     unable to write variables to NVRAM and results in operating system failures.
     </p></li>
<li class='enumerate' id='x1-26012x6'>
     <!-- l. 1542 --><p class='noindent'><span class='ec-lmtt-10'>DiscardHibernateMap</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reuse original hibernate memory map.
     </p><!-- l. 1547 --><p class='noindent'>This option forces the XNU kernel to ignore a newly supplied memory map and assume that it did not change after
     waking from hibernation. This behaviour is required by Windows to work. Windows mandates <a href='https://docs.microsoft.com/en-us/windows-hardware/design/device-experiences/oem-uefi#hibernation-state-s4-transition-requirements'>preserving</a> runtime
     memory size and location after S4 wake.
                                                                                                  
                                                                                                  
     </p><!-- l. 1553 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This may be used to workaround defective memory map implementations on older, rare legacy hardware. Examples
     of such hardware are Ivy Bridge laptops with Insyde firmware such as the Acer V3-571G. Do not use this option without
     a full understanding of the implications.
     </p></li>
<li class='enumerate' id='x1-26014x7'>
     <!-- l. 1558 --><p class='noindent'><span class='ec-lmtt-10'>EnableSafeModeSlide</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Patch bootloader to have KASLR enabled in safe mode.
     </p><!-- l. 1563 --><p class='noindent'>This option is relevant to users with issues booting to safe mode (e.g. by holding <span class='ec-lmtt-10'>shift </span>or with using the <span class='ec-lmtt-10'>-x </span>boot
     argument). By default, safe mode forces <span class='ec-lmtt-10'>0 </span>slide as if the system was launched with the <span class='ec-lmtt-10'>slide=0 </span>boot
     argument.
</p>
         <ul class='itemize1'>
         <li class='itemize'>This quirk attempts to patch the <span class='ec-lmtt-10'>boot.efi </span>file to remove this limitation and to allow using other values
         (from <span class='ec-lmtt-10'>1 </span>to <span class='ec-lmtt-10'>255 </span>inclusive).
         </li>
         <li class='itemize'>This quirk requires enabling <span class='ec-lmtt-10'>ProvideCustomSlide</span>.</li></ul>
     <!-- l. 1575 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this option is dependent on the availability of safe mode. It can be enabled when booting to safe mode
     fails.
     </p></li>
<li class='enumerate' id='x1-26016x8'>
     <!-- l. 1579 --><p class='noindent'><span class='ec-lmtt-10'>EnableWriteUnprotector</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Permit write access to UEFI runtime services code.
     </p><!-- l. 1584 --><p class='noindent'>This option bypasses <span class='ec-lmtt-10'>W^X </span>permissions in code pages of UEFI runtime services by removing write protection (<span class='ec-lmtt-10'>WP</span>) bit from
     <span class='ec-lmtt-10'>CR0 </span>register during their execution. This quirk requires <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol implemented in
     <span class='ec-lmtt-10'>OpenRuntime.efi</span>.
     </p><!-- l. 1589 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This quirk may potentially weaken firmware security. Please use <span class='ec-lmtt-10'>RebuildAppleMemoryMap </span>if the firmware supports
     memory attributes table (MAT). Refer to the <span class='ec-lmtt-10'>OCABC: MAT support is 1/0 </span>log entry to determine whether MAT is
     supported.
     </p></li>
<li class='enumerate' id='x1-26018x9'>
     <!-- l. 1594 --><p class='noindent'><span class='ec-lmtt-10'>ForceBooterSignature</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set macOS <span class='ec-lmtt-10'>boot-signature </span>to OpenCore launcher.
     </p><!-- l. 1599 --><p class='noindent'>Booter signature, essentially a SHA-1 hash of the loaded image, is used by Mac EFI to verify the authenticity of the
     bootloader when waking from hibernation. This option forces macOS to use OpenCore launcher SHA-1 hash as a booter
     signature to let OpenCore shim hibernation wake on Mac EFI firmware.
     </p><!-- l. 1604 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: OpenCore launcher path is determined from <span class='ec-lmtt-10'>LauncherPath </span>property.
     </p></li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-26020x10'>
     <!-- l. 1607 --><p class='noindent'><span class='ec-lmtt-10'>ForceExitBootServices</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Retry <span class='ec-lmtt-10'>ExitBootServices </span>with new memory map on failure.
     </p><!-- l. 1612 --><p class='noindent'>Try to ensure that the <span class='ec-lmtt-10'>ExitBootServices </span>call succeeds. If required, an outdated <span class='ec-lmtt-10'>MemoryMap </span>key argument can be used
     by obtaining the current memory map and retrying the <span class='ec-lmtt-10'>ExitBootServices </span>call.
     </p><!-- l. 1616 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is determined by early boot crashes of the firmware. Do not use this option without a full
     understanding of the implications.
     </p></li>
<li class='enumerate' id='x1-26022x11'>
     <!-- l. 1620 --><p class='noindent'><span class='ec-lmtt-10'>ProtectMemoryRegions</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Protect memory regions from incorrect access.
     </p><!-- l. 1625 --><p class='noindent'>Some types of firmware incorrectly map certain memory regions:
</p>
         <ul class='itemize1'>
         <li class='itemize'>The CSM region can be marked as boot services code, or data, which leaves it as free memory for the XNU
         kernel.
         </li>
         <li class='itemize'>MMIO regions can be marked as reserved memory and stay unmapped. They may however be required to
         be accessible at runtime for NVRAM support.</li></ul>
     <!-- l. 1635 --><p class='noindent'>This quirk attempts to fix the types of these regions, e.g. ACPI NVS for CSM or MMIO for MMIO.
     </p><!-- l. 1638 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is determined by artifacts, sleep wake issues, and boot failures. This quirk is typically only
     required by very old firmware.
     </p></li>
<li class='enumerate' id='x1-26024x12'>
     <!-- l. 1643 --><p class='noindent'><span class='ec-lmtt-10'>ProtectSecureBoot</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Protect UEFI Secure Boot variables from being written.
     </p><!-- l. 1648 --><p class='noindent'>Reports security violation during attempts to write to <span class='ec-lmtt-10'>db</span>, <span class='ec-lmtt-10'>dbx</span>, <span class='ec-lmtt-10'>PK</span>, and <span class='ec-lmtt-10'>KEK </span>variables from the operating
     system.
     </p><!-- l. 1651 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This quirk attempts to avoid issues with NVRAM implementations with fragmentation issues, such as on the
     <span class='ec-lmtt-10'>MacPro5,1 </span>as well as on certain Insyde firmware without garbage collection or with defective garbage
     collection.
     </p></li>
<li class='enumerate' id='x1-26026x13'>
     <!-- l. 1656 --><p class='noindent'><span class='ec-lmtt-10'>ProtectUefiServices</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Protect UEFI services from being overridden by the firmware.
                                                                                                  
                                                                                                  
     </p><!-- l. 1661 --><p class='noindent'>Some modern firmware, including on virtual machines such as VMware, may update pointers to UEFI services during
     driver loading and related actions. Consequently, this directly obstructs other quirks that affect memory management,
     such as <span class='ec-lmtt-10'>DevirtualiseMmio</span>, <span class='ec-lmtt-10'>ProtectMemoryRegions</span>, or <span class='ec-lmtt-10'>RebuildAppleMemoryMap</span>, and may also obstruct other quirks
     depending on the scope of such.
     </p><!-- l. 1667 --><p class='noindent'>GRUB shim makes similar on-the-fly changes to various UEFI image services, which are also protected against by this
     quirk.
     </p><!-- l. 1670 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: On VMware, the need for this quirk may be determined by the appearance of the “Your Mac OS guest might run
     unreliably with more than one virtual core.” message.
     </p><!-- l. 1673 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: This quirk is needed for correct operation if OpenCore is chainloaded from GRUB with BIOS Secure Boot
     enabled.
     </p></li>
<li class='enumerate' id='x1-26028x14'>
     <!-- l. 1677 --><p class='noindent'><span class='ec-lmtt-10'>ProvideCustomSlide</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide custom KASLR slide on low memory.
     </p><!-- l. 1682 --><p class='noindent'>This option performs memory map analysis of the firmware and checks whether all slides (from <span class='ec-lmtt-10'>1 </span>to <span class='ec-lmtt-10'>255</span>) can be used. As
     <span class='ec-lmtt-10'>boot.efi </span>generates this value randomly with <span class='ec-lmtt-10'>rdrand </span>or pseudo randomly <span class='ec-lmtt-10'>rdtsc</span>, there is a chance of boot failure when it
     chooses a conflicting slide. In cases where potential conflicts exist, this option forces macOS to select a pseudo random
     value from the available values. This also ensures that the <span class='ec-lmtt-10'>slide= </span>argument is never passed to the operating system (for
     security reasons).
     </p><!-- l. 1690 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is determined by the <span class='ec-lmtt-10'>OCABC: Only N/256 slide values are usable! </span>message in the
     debug log.
     </p></li>
<li class='enumerate' id='x1-26030x15'>
     <!-- l. 1694 --><p class='noindent'><span class='ec-lmtt-10'>ProvideMaxSlide</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide maximum KASLR slide when higher ones are unavailable.
     </p><!-- l. 1699 --><p class='noindent'>This option overrides the maximum slide of 255 by a user specified value between 1 and 254 (inclusive) when
     <span class='ec-lmtt-10'>ProvideCustomSlide </span>is enabled. It is assumed that modern firmware allocates pool memory from top
     to bottom, effectively resulting in free memory when slide scanning is used later as temporary memory
     during kernel loading. When such memory is not available, this option stops the evaluation of higher
     slides.
     </p><!-- l. 1705 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is determined by random boot failures when <span class='ec-lmtt-10'>ProvideCustomSlide </span>is enabled
     and the randomized slide falls into the unavailable range. When <span class='ec-lmtt-10'>AppleDebug </span>is enabled, the debug log
     typically contains messages such as <span class='ec-lmtt-10'>AAPL: [EB|‘LD:LKC] } Err(0x9)</span>. To find the optimal value, append
     <span class='ec-lmtt-10'>slide=X</span>, where <span class='ec-lmtt-10'>X </span>is the slide value, to the <span class='ec-lmtt-10'>boot-args </span>and select the largest one that does not result in boot
     failures.
     </p></li>
<li class='enumerate' id='x1-26032x16'>
     <!-- l. 1713 --><p class='noindent'><span class='ec-lmtt-10'>RebuildAppleMemoryMap</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Generate macOS compatible Memory Map.
     </p><!-- l. 1718 --><p class='noindent'>The Apple kernel has several limitations on parsing the UEFI memory map:
</p>
                                                                                                  
                                                                                                  
         <ul class='itemize1'>
         <li class='itemize'>The Memory map size must not exceed 4096 bytes as the Apple kernel maps it as a single 4K page. As
         some types of firmware can have very large memory maps, potentially over 100 entries, the Apple kernel
         will crash on boot.
         </li>
         <li class='itemize'>The Memory attributes table is ignored. <span class='ec-lmtt-10'>EfiRuntimeServicesCode </span>memory statically gets <span class='ec-lmtt-10'>RX </span>permissions
         while all other memory types get <span class='ec-lmtt-10'>RW </span>permissions. As some firmware drivers may write to global variables at
         runtime, the Apple kernel will crash at calling UEFI runtime services unless the driver <span class='ec-lmtt-10'>.data </span>section has a
         <span class='ec-lmtt-10'>EfiRuntimeServicesData </span>type.</li></ul>
     <!-- l. 1733 --><p class='noindent'>To workaround these limitations, this quirk applies memory attribute table permissions to the memory map passed to the
     Apple kernel and optionally attempts to unify contiguous slots of similar types if the resulting memory map exceeds 4
     KB.
     </p><!-- l. 1738 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Since several types of firmware come with incorrect memory protection tables, this quirk often comes paired with
     <span class='ec-lmtt-10'>SyncRuntimePermissions</span>.
     </p><!-- l. 1741 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: The need for this quirk is determined by early boot failures. This quirk replaces <span class='ec-lmtt-10'>EnableWriteUnprotector </span>on
     firmware supporting Memory Attribute Tables (MAT). This quirk is typically unnecessary when using <span class='ec-lmtt-10'>OpenDuetPkg </span>but
     may be required to boot macOS 10.6, and earlier, for reasons that are as yet unclear.
     </p></li>
<li class='enumerate' id='x1-26034x17'>
     <!-- l. 1748 --><p class='noindent'><span class='ec-lmtt-10'>ResizeAppleGpuBars</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reduce GPU PCI BAR sizes for compatibility with macOS.
     </p><!-- l. 1753 --><p class='noindent'>This quirk reduces GPU PCI BAR sizes for Apple macOS up to the specified value or lower if it is unsupported. The
     specified value follows PCI Resizable BAR spec. While Apple macOS supports a theoretical 1 GB maximum, in practice
     all non-default values may not work correctly. For this reason the only supported value for this quirk is the minimal
     supported BAR size, i.e. <span class='ec-lmtt-10'>0</span>. Use <span class='ec-lmtt-10'>-1 </span>to disable this quirk.
     </p><!-- l. 1760 --><p class='noindent'>For development purposes one may take risks and try other values. Consider a GPU with 2 BARs: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>BAR0 </span>supports sizes from 256 MB to 8 GB. Its value is 4 GB.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BAR1 </span>supports sizes from 2 MB to 256 MB. Its value is 256 MB.</li></ul>
     <!-- l. 1768 --><p class='noindent'><span class='ec-lmri-10'>Example 1</span>: Setting <span class='ec-lmtt-10'>ResizeAppleGpuBars </span>to 1 GB will change <span class='ec-lmtt-10'>BAR0 </span>to 1 GB and leave <span class='ec-lmtt-10'>BAR1 </span>unchanged.
     <br class='newline' /><span class='ec-lmri-10'>Example 2</span>: Setting <span class='ec-lmtt-10'>ResizeAppleGpuBars </span>to 1 MB will change <span class='ec-lmtt-10'>BAR0 </span>to 256 MB and <span class='ec-lmtt-10'>BAR0 </span>to 2 MB. <br class='newline' /><span class='ec-lmri-10'>Example 3</span>: Setting <span class='ec-lmtt-10'>ResizeAppleGpuBars </span>to 16 GB will make no changes.
     </p><!-- l. 1777 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: See <span class='ec-lmtt-10'>ResizeGpuBars </span>quirk for general GPU PCI BAR size configuration and more details about the
     technology.
     </p></li>
<li class='enumerate' id='x1-26036x18'>
     <!-- l. 1781 --><p class='noindent'><span class='ec-lmtt-10'>SetupVirtualMap</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Setup virtual memory at <span class='ec-lmtt-10'>SetVirtualAddresses</span>.
                                                                                                  
                                                                                                  
     </p><!-- l. 1786 --><p class='noindent'>Some types of firmware access memory by virtual addresses after a <span class='ec-lmtt-10'>SetVirtualAddresses </span>call, resulting in early boot
     crashes. This quirk workarounds the problem by performing early boot identity mapping of assigned virtual addresses to
     physical memory.
     </p><!-- l. 1791 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is determined by early boot failures.
     </p></li>
<li class='enumerate' id='x1-26038x19'>
     <!-- l. 1794 --><p class='noindent'><span class='ec-lmtt-10'>SignalAppleOS</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Report macOS being loaded through OS Info for any OS.
     </p><!-- l. 1799 --><p class='noindent'>This quirk is useful on Mac firmware, which loads different operating systems with different hardware configurations.
     For example, it is supposed to enable Intel GPU in Windows and Linux in some dual-GPU MacBook
     models.
     </p></li>
<li class='enumerate' id='x1-26040x20'>
     <!-- l. 1804 --><p class='noindent'><span class='ec-lmtt-10'>SyncRuntimePermissions</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update memory permissions for the runtime environment.
     </p><!-- l. 1809 --><p class='noindent'>Some types of firmware fail to properly handle runtime permissions: </p>
         <ul class='itemize1'>
         <li class='itemize'>They incorrectly mark <span class='ec-lmtt-10'>OpenRuntime </span>as not executable in the memory map.
         </li>
         <li class='itemize'>They incorrectly mark <span class='ec-lmtt-10'>OpenRuntime </span>as not executable in the memory attributes table.
         </li>
         <li class='itemize'>They lose entries from the memory attributes table after <span class='ec-lmtt-10'>OpenRuntime </span>is loaded.
         </li>
         <li class='itemize'>They mark items in the memory attributes table as read-write-execute.</li></ul>
     <!-- l. 1820 --><p class='noindent'>This quirk attempts to update the memory map and memory attributes table to correct this.
     </p><!-- l. 1822 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The need for this quirk is indicated by early boot failures (note: includes halt at black screen as well as more
     obvious crash). Particularly likely to affect early boot of Windows or Linux (but not always both) on affected systems.
     Only firmware released after 2017 is typically affected.
</p>
     </li></ol>
<!-- l. 1828 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='deviceproperties'><span class='titlemark'>6   </span> <a id='x1-270006'></a>DeviceProperties</h3>
<!-- l. 1830 --><p class='noindent'>
</p>
                                                                                                  
                                                                                                  
<h4 class='subsectionHead' id='introduction3'><span class='titlemark'>6.1   </span> <a id='x1-280006.1'></a>Introduction</h4>
<!-- l. 1832 --><p class='noindent'>Device configuration is provided to macOS with a dedicated buffer, called <span class='ec-lmtt-10'>EfiDevicePathPropertyDatabase</span>. This buffer is a
serialised map of DevicePaths to a map of property names and their values.
</p><!-- l. 1836 --><p class='noindent'>Property data can be debugged with <a href='https://github.com/acidanthera/gfxutil'>gfxutil</a>. To obtain current property data, use the following command in macOS:
</p><!-- l. 1839 -->
<pre class='lstlisting' id='listing-4'><span class='label'><a id='x1-28001r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>ioreg</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-lw0 </span><span class='ec-lmtt-10'>-p </span><span class='ec-lmtt-10'>IODeviceTree </span><span class='ec-lmtt-10'>-n </span><span class='ec-lmtt-10'>efi </span><span class='ec-lmtt-10'>-r </span><span class='ec-lmtt-10'>-x </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>grep </span><span class='ec-lmtt-10'>device-properties </span><span class='ec-lmtt-10'>|</span> 
</span><span class='label'><a id='x1-28002r2'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>sed </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>s/.*&lt;//;s/&gt;.*//</span><span class='ts1-lmtt10-'>' </span><span class='ec-lmtt-10'>&gt; </span><span class='ec-lmtt-10'>/tmp/device-properties.hex </span><span class='ec-lmtt-10'>&amp;&amp;</span> 
</span><span class='label'><a id='x1-28003r3'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>gfxutil </span><span class='ec-lmtt-10'>/tmp/device-properties.hex </span><span class='ec-lmtt-10'>/tmp/device-properties.plist </span><span class='ec-lmtt-10'>&amp;&amp;</span> 
</span><span class='label'><a id='x1-28004r4'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>cat </span><span class='ec-lmtt-10'>/tmp/device-properties.plist</span></span></pre>
<!-- l. 1846 --><p class='noindent'>Device properties are part of the <span class='ec-lmtt-10'>IODeviceTree </span>(<span class='ec-lmtt-10'>gIODT</span>) plane of the macOS I/O Registry. This plane has several construction
stages relevant for the platform initialisation. While the early construction stage is performed by the XNU kernel in the
<span class='ec-lmtt-10'>IODeviceTreeAlloc </span>method, the majority of the construction is performed by the platform expert, implemented in
<span class='ec-lmtt-10'>AppleACPIPlatformExpert.kext</span>.
</p><!-- l. 1853 --><p class='noindent'>AppleACPIPlatformExpert incorporates two stages of <span class='ec-lmtt-10'>IODeviceTree </span>construction implemented by calling <br class='newline' /><span class='ec-lmtt-10'>AppleACPIPlatformExpert::mergeDeviceProperties</span>:
</p><!-- l. 1857 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-28006x1'>During ACPI table initialisation through the recursive ACPI namespace scanning by the calls to <br class='newline' /><span class='ec-lmtt-10'>AppleACPIPlatformExpert::createDTNubs</span>.
     </li>
<li class='enumerate' id='x1-28008x2'>During IOService registration (<span class='ec-lmtt-10'>IOServices::registerService</span>) callbacks implemented as a part of <br class='newline' /><span class='ec-lmtt-10'>AppleACPIPlatformExpert::platformAdjustService </span>function and its private worker method <br class='newline' /><span class='ec-lmtt-10'>AppleACPIPlatformExpert::platformAdjustPCIDevice </span>specific to the PCI devices.</li></ol>
<!-- l. 1870 --><p class='noindent'>The application of the stages depends on the device presence in ACPI tables. The first stage applies very early but exclusively
to the devices present in ACPI tables. The second stage applies to all devices much later after the PCI configuration and may
repeat the first stage if the device was not present in ACPI.
</p><!-- l. 1875 --><p class='noindent'>For all kernel extensions that may inspect the <span class='ec-lmtt-10'>IODeviceTree </span>plane without probing, such as <span class='ec-lmtt-10'>Lilu </span>and its plugins (e.g.
<span class='ec-lmtt-10'>WhateverGreen</span>), it is especially important to ensure device presence in the ACPI tables. A failure to do so may result <span class='ec-lmbx-10'>in
</span><span class='ec-lmbx-10'>erratic behaviour </span>caused by ignoring the injected device properties as they were not constructed at the first stage. See
<span class='ec-lmtt-10'>SSDT-IMEI.dsl </span>and <span class='ec-lmtt-10'>SSDT-BRG0.dsl </span>for an example.
</p><!-- l. 1882 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties2'><span class='titlemark'>6.2   </span> <a id='x1-290006.2'></a>Properties</h4>
<!-- l. 1884 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-29002x1'>
     <!-- l. 1886 --><p class='noindent'><span class='ec-lmtt-10'>Add</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets device properties from a map (<span class='ec-lmtt-10'>plist dict</span>) of device paths to a map (<span class='ec-lmtt-10'>plist dict</span>) of variable
     names and their values in <span class='ec-lmtt-10'>plist multidata </span>format.
     </p><!-- l. 1892 --><p class='noindent'><span class='ec-lmri-10'>Note     1</span>:      Device      paths      must      be      provided      in      canonic      string      format      (e.g.
     <span class='ec-lmtt-10'>PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)</span>).
     </p><!-- l. 1895 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Existing properties will not be changed unless deleted in the <span class='ec-lmtt-10'>DeviceProperties Delete </span>section.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-29004x2'>
     <!-- l. 1899 --><p class='noindent'><span class='ec-lmtt-10'>Delete</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Removes device properties from a map (<span class='ec-lmtt-10'>plist dict</span>) of device paths to an array (<span class='ec-lmtt-10'>plist array</span>)
     of variable names in <span class='ec-lmtt-10'>plist string </span>format.
     </p><!-- l. 1905 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Currently, existing properties may only exist on firmware with DeviceProperties drivers (e.g. Apple). Hence,
     there is typically no reason to delete variables unless a new driver has been installed.
</p>
     </li></ol>
<!-- l. 1911 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='common-properties'><span class='titlemark'>6.3   </span> <a id='x1-300006.3'></a>Common Properties</h4>
<!-- l. 1913 --><p class='noindent'>Some known properties include:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>device-id</span>
     User-specified device identifier used for I/O Kit matching. Has 4 byte data type.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>vendor-id</span>
     User-specified vendor identifier used for I/O Kit matching. Has 4 byte data type.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>AAPL,ig-platform-id</span>
     Intel GPU framebuffer identifier used for framebuffer selection on Ivy Bridge and newer. Has 4 byte data type.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>AAPL,snb-platform-id</span>
     Intel GPU framebuffer identifier used for framebuffer selection on Sandy Bridge. Has 4 byte data type.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>layout-id</span>
     Audio layout used for AppleHDA layout selection. Has 4 byte data type.</li></ul>
<!-- l. 1942 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='kernel'><span class='titlemark'>7   </span> <a id='x1-310007'></a>Kernel</h3>
<!-- l. 1944 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction4'><span class='titlemark'>7.1   </span> <a id='x1-320007.1'></a>Introduction</h4>
<!-- l. 1946 --><p class='noindent'>This section allows the application of different kinds of kernelspace modifications on Apple Kernel (<a href='https://opensource.apple.com/source/xnu'>XNU</a>). The modifications
                                                                                                  
                                                                                                  
currently provide driver (kext) injection, kernel and driver patching, and driver blocking.
</p><!-- l. 1951 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties3'><span class='titlemark'>7.2   </span> <a id='x1-330007.2'></a>Properties</h4>
<!-- l. 1953 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-33002x1'>
     <!-- l. 1955 --><p class='noindent'><span class='ec-lmtt-10'>Add</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load selected kernel extensions (kexts) from the <span class='ec-lmtt-10'>OC/Kexts </span>directory.
     </p><!-- l. 1960 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each kext. Refer to the <a href='#add-properties1'>Add Properties</a> section below for details.
     </p><!-- l. 1963 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: The load order is based on the order in which the kexts appear in the array. Hence, dependencies must
     appear before kexts that depend on them.
     </p><!-- l. 1966 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: To track the dependency order, inspect the <span class='ec-lmtt-10'>OSBundleLibraries </span>key in the <span class='ec-lmtt-10'>Info.plist </span>file of the kext
     being added. Any kext included under the key is a dependency that must appear before the kext being added.
     </p><!-- l. 1970 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: Kexts may have inner kexts (<span class='ec-lmtt-10'>Plugins</span>) included in the bundle. Such <span class='ec-lmtt-10'>Plugins </span>must be added separately
     and follow the same global ordering rules as other kexts.
     </p></li>
<li class='enumerate' id='x1-33004x2'>
     <!-- l. 1975 --><p class='noindent'><span class='ec-lmtt-10'>Block</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Remove selected kernel extensions (kexts) from the prelinked kernel.
     </p><!-- l. 1980 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dictionary </span>values, describing each blocked kext. Refer to the <a href='#block-properties'>Block Properties</a> section
     below for details.
     </p></li>
<li class='enumerate' id='x1-33006x3'><span class='ec-lmtt-10'>Emulate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Emulate certain hardware in kernelspace via parameters described in the <a href='#emulate-properties'>Emulate Properties</a>
     section below.
     </li>
<li class='enumerate' id='x1-33008x4'>
     <!-- l. 1990 --><p class='noindent'><span class='ec-lmtt-10'>Force</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load kernel extensions (kexts) from the system volume if they are not cached.
     </p><!-- l. 1995 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each kext. Refer to the <a href='#force-properties'>Force Properties</a> section below for details.
     This section resolves the problem of injecting kexts that depend on other kexts, which are not otherwise cached.
     The issue typically affects older operating systems, where various dependency kexts, such as <span class='ec-lmtt-10'>IOAudioFamily </span>or
     <span class='ec-lmtt-10'>IONetworkingFamily </span>may not be present in the kernel cache by default.
                                                                                                  
                                                                                                  
     </p><!-- l. 2002 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: The load order is based on the order in which the kexts appear in the array. Hence, dependencies must
     appear before kexts that depend on them.
     </p><!-- l. 2005 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: <span class='ec-lmtt-10'>Force </span>happens before <span class='ec-lmtt-10'>Add</span>.
     </p><!-- l. 2007 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: The signature of the “forced” kext is not checked in any way. This makes using this feature extremely
     dangerous and undesirable for secure boot.
     </p><!-- l. 2010 --><p class='noindent'><span class='ec-lmri-10'>Note 4</span>: This feature may not work on encrypted partitions in newer operating systems.
     </p></li>
<li class='enumerate' id='x1-33010x5'>
     <!-- l. 2013 --><p class='noindent'><span class='ec-lmtt-10'>Patch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform binary patches in kernel and drivers prior to driver addition and removal.
     </p><!-- l. 2019 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dictionary </span>values, describing each patch. Refer to the <a href='#patch-properties2'>Patch Properties</a> section below
     for details.
     </p></li>
<li class='enumerate' id='x1-33012x6'><span class='ec-lmtt-10'>Quirks</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual kernel and driver quirks described in the <a href='#quirks-properties2'>Quirks Properties</a> section below.
     </li>
<li class='enumerate' id='x1-33014x7'><span class='ec-lmtt-10'>Scheme</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Define kernelspace operation mode via parameters described in the <a href='#scheme-properties'>Scheme Properties</a> section
     below.
</li></ol>
<!-- l. 2037 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='add-properties1'><span class='titlemark'>7.3   </span> <a id='x1-340007.3'></a>Add Properties</h4>
<!-- l. 2039 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-34002x1'><span class='ec-lmtt-10'>Arch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Apply to any supported architecture)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>x86_64</span>).
     </li>
<li class='enumerate' id='x1-34004x2'><span class='ec-lmtt-10'>BundlePath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext bundle path (e.g. <span class='ec-lmtt-10'>Lilu.kext </span>or <span class='ec-lmtt-10'>MyKext.kext/Contents/PlugIns/MySubKext.kext</span>).
     </li>
<li class='enumerate' id='x1-34006x3'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-34008x4'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to add this kernel extension.
     </li>
<li class='enumerate' id='x1-34010x5'><span class='ec-lmtt-10'>ExecutablePath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext executable path relative to bundle (e.g. <span class='ec-lmtt-10'>Contents/MacOS/Lilu</span>).
     </li>
<li class='enumerate' id='x1-34012x6'>
     <!-- l. 2074 --><p class='noindent'><span class='ec-lmtt-10'>MaxKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Adds kernel extension on specified macOS version or older.
     </p><!-- l. 2079 --><p class='noindent'><a id='kernmatch'></a>Kernel version can be obtained with <span class='ec-lmtt-10'>uname -r </span>command, and should look like 3 numbers separated by dots,
     for example <span class='ec-lmtt-10'>18.7.0 </span>is the kernel version for <span class='ec-lmtt-10'>10.14.6</span>. Kernel version interpretation is implemented as
     follows:
     </p><table class='align-star'>
           <tr><td class='align-odd'><span class='lmmi-10'>ParseDarwinV ersion</span><span class='rm-lmr-10'>(</span><span class='lmmi-10'>κ,λ,μ</span><span class='rm-lmr-10'>) </span><span class='rm-lmr-10'>= </span><span class='lmmi-10'>κ </span><span class='lmsy-10'>⋅ </span><span class='rm-lmr-10'>10000</span>Where <span class='lmmi-10'>κ </span><span class='lmsy-10'>∈ </span><span class='rm-lmr-10'>(0</span><span class='lmmi-10'>,</span><span class='rm-lmr-10'>99)</span> is kernel version major
                                         <span class='rm-lmr-10'>+ </span><span class='lmmi-10'>λ </span><span class='lmsy-10'>⋅ </span><span class='rm-lmr-10'>100</span>   Where <span class='lmmi-10'>λ </span><span class='lmsy-10'>∈ </span><span class='rm-lmr-10'>(0</span><span class='lmmi-10'>,</span><span class='rm-lmr-10'>99)</span> is kernel version minor
                                         <span class='rm-lmr-10'>+ </span><span class='lmmi-10'>μ</span>        Where <span class='lmmi-10'>μ </span><span class='lmsy-10'>∈ </span><span class='rm-lmr-10'>(0</span><span class='lmmi-10'>,</span><span class='rm-lmr-10'>99)</span> is kernel version patch </td><td class='align-even'></td>           <td class='align-label'>       </td></tr></table>
                                                                                                  
                                                                                                  
     <!-- l. 2092 --><p class='noindent'>Kernel version comparison is implemented as follows:
     </p><table class='align-star'>
   <tr><td class='align-odd'><span class='lmmi-10'>α</span></td>   <td class='align-even'> <span class='rm-lmr-10'>= </span><img align='middle' alt='{
 P arseDarwinV  ersion(MinKernel),               If MinKernel is valid
 0                                            Otherwise' class='left' src='Configuration1x.svg' /></td>            <td class='align-label'></td>   <td class='align-label'>
   </td></tr><tr><td class='align-odd'><span class='lmmi-10'>β</span></td>   <td class='align-even'> <span class='rm-lmr-10'>= </span><img align='middle' alt='{
 P arseDarwinV  ersion(MaxKernel),               If MaxKernel is valid
 ∞                                            Otherwise' class='left' src='Configuration2x.svg' /></td>            <td class='align-label'></td>   <td class='align-label'>
   </td></tr><tr><td class='align-odd'><span class='lmmi-10'>γ</span></td>   <td class='align-even'> <span class='rm-lmr-10'>= </span><img align='middle' alt='{
 P arseDarwinV  ersion(FindDarwinV ersion()),    If valid &quot;Darwin Kernel Version&quot; is found
 ∞                                            Otherwise' class='left' src='Configuration3x.svg' /></td>   <td class='align-label'></td>   <td class='align-label'>
   </td></tr><tr><td class='align-odd'></td>    <td class='align-even'><span class='lmmi-10'>                                         f</span><span class='rm-lmr-10'>(</span><span class='lmmi-10'>α,β,γ</span><span class='rm-lmr-10'>) = </span><span class='lmmi-10'>α </span><span class='lmsy-10'>≤ </span><span class='lmmi-10'>γ </span><span class='lmsy-10'>≤ </span><span class='lmmi-10'>β</span></td>                                      <td class='align-label'></td>   <td class='align-label'></td></tr></table>
     <!-- l. 2111 --><p class='noindent'>Here <span class='lmmi-10'>ParseDarwinV ersion </span>argument is assumed to be 3 integers obtained by splitting Darwin kernel version string from
     left to right by the <span class='ec-lmtt-10'>. </span>symbol. <span class='lmmi-10'>FindDarwinV ersion </span>function looks up Darwin kernel version by locating <span class='ec-lmtt-10'>"Darwin Kernel
     </span><span class='ec-lmtt-10'>Version </span><span class='lmmi-10'>κ</span><span class='ec-lmtt-10'>.</span><span class='lmmi-10'>λ</span><span class='ec-lmtt-10'>.</span><span class='lmmi-10'>μ</span><span class='ec-lmtt-10'>" </span>string in the kernel image.
     </p></li>
<li class='enumerate' id='x1-34014x7'>
     <!-- l. 2117 --><p class='noindent'><span class='ec-lmtt-10'>MinKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Adds kernel extension on specified macOS version or newer.
     </p><!-- l. 2122 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-34016x8'><span class='ec-lmtt-10'>PlistPath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext <span class='ec-lmtt-10'>Info.plist </span>path relative to bundle (e.g. <span class='ec-lmtt-10'>Contents/Info.plist</span>).
</li></ol>
                                                                                                  
                                                                                                  
<!-- l. 2133 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='block-properties'><span class='titlemark'>7.4   </span> <a id='x1-350007.4'></a>Block Properties</h4>
<!-- l. 2135 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-35002x1'><span class='ec-lmtt-10'>Arch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Apply to any supported architecture)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext block architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>x86_64</span>).
     </li>
<li class='enumerate' id='x1-35004x2'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-35006x3'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to block this kernel extension.
     </li>
<li class='enumerate' id='x1-35008x4'><span class='ec-lmtt-10'>Identifier</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext bundle identifier (e.g. <span class='ec-lmtt-10'>com.apple.driver.AppleTyMCEDriver</span>).
     </li>
<li class='enumerate' id='x1-35010x5'>
     <!-- l. 2163 --><p class='noindent'><span class='ec-lmtt-10'>MaxKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Blocks kernel extension on specified macOS version or older.
     </p><!-- l. 2168 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-35012x6'>
     <!-- l. 2171 --><p class='noindent'><span class='ec-lmtt-10'>MinKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Blocks kernel extension on specified macOS version or newer.
     </p><!-- l. 2176 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-35014x7'>
     <!-- l. 2179 --><p class='noindent'><span class='ec-lmtt-10'>Strategy</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Disable </span>(Forcibly make the kernel driver kmod startup code return failure)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Determines the behaviour of kernel driver blocking.
     </p><!-- l. 2184 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Disable </span>— Forcibly make the kernel driver kmod startup code return failure.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Exclude </span>— Remove the kernel driver from the kernel cache by dropping plist entry and filling in zeroes.</li></ul>
     <!-- l. 2192 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: It is risky to <span class='ec-lmtt-10'>Exclude </span>a kext that is a dependency of others.
     </p><!-- l. 2194 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: At this moment <span class='ec-lmtt-10'>Exclude </span>is only applied to <span class='ec-lmtt-10'>prelinkedkernel </span>and newer mechanisms.
     </p><!-- l. 2196 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: In most cases strategy <span class='ec-lmtt-10'>Exclude </span>requires the new kext to be injected as a replacement.
</p>
     </li></ol>
<!-- l. 2200 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='emulate-properties'><span class='titlemark'>7.5   </span> <a id='x1-360007.5'></a>Emulate Properties</h4>
<!-- l. 2202 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-36002x1'>
     <!-- l. 2204 --><p class='noindent'><span class='ec-lmtt-10'>Cpuid1Data</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 16 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sequence of <span class='ec-lmtt-10'>EAX</span>, <span class='ec-lmtt-10'>EBX</span>, <span class='ec-lmtt-10'>ECX</span>, <span class='ec-lmtt-10'>EDX </span>values to replace <span class='ec-lmtt-10'>CPUID (1) </span>call in XNU kernel.
     </p><!-- l. 2210 --><p class='noindent'>This property primarily meets three requirements:
</p>
         <ul class='itemize1'>
         <li class='itemize'>Enabling support for an unsupported CPU model (e.g. Intel Pentium).
         </li>
         <li class='itemize'>Enabling support for a CPU model not yet supported by a specific version of macOS (typically old versions).
         </li>
         <li class='itemize'>Enabling XCPM support for an unsupported CPU variant.</li></ul>
     <!-- l. 2219 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: It may also be the case that the CPU model is supported but there is no power management supported (e.g.
     virtual machines). In this case, <span class='ec-lmtt-10'>MinKernel </span>and <span class='ec-lmtt-10'>MaxKernel </span>can be set to restrict CPU virtualisation and dummy power
     management patches to the particular macOS kernel version.
                                                                                                  
                                                                                                  
     </p><!-- l. 2223 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Only the value of <span class='ec-lmtt-10'>EAX</span>, which represents the full CPUID, typically needs to be accounted for and remaining bytes
     should be left as zeroes. The byte order is Little Endian. For example, <span class='ec-lmtt-10'>C3 06 03 00 </span>stands for CPUID <span class='ec-lmtt-10'>0x0306C3</span>
     (Haswell).
     </p><!-- l. 2228 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: For XCPM support it is recommended to use the following combinations. Be warned that one is required to set
     the correct <a href='https://github.com/dortania/bugtracker/issues/190'>frequency vectors</a> matching the installed CPU.
</p>
         <ul class='itemize1'>
         <li class='itemize'>Haswell-E (<span class='ec-lmtt-10'>0x0306F2</span>) to Haswell (<span class='ec-lmtt-10'>0x0306C3</span>):<br class='newline' /><span class='ec-lmtt-10'>Cpuid1Data</span>: <span class='ec-lmtt-10'>C3 06 03 00 00 00 00 00 00 00 00 00 00 00 00 00</span><br class='newline' /><span class='ec-lmtt-10'>Cpuid1Mask</span>: <span class='ec-lmtt-10'>FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00</span>
         </li>
         <li class='itemize'>Broadwell-E (<span class='ec-lmtt-10'>0x0406F1</span>) to Broadwell (<span class='ec-lmtt-10'>0x0306D4</span>):<br class='newline' /><span class='ec-lmtt-10'>Cpuid1Data</span>: <span class='ec-lmtt-10'>D4 06 03 00 00 00 00 00 00 00 00 00 00 00 00 00</span><br class='newline' /><span class='ec-lmtt-10'>Cpuid1Mask</span>: <span class='ec-lmtt-10'>FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00</span>
         </li>
         <li class='itemize'>Comet Lake U62 (<span class='ec-lmtt-10'>0x0A0660</span>) to Comet Lake U42 (<span class='ec-lmtt-10'>0x0806EC</span>):<br class='newline' /><span class='ec-lmtt-10'>Cpuid1Data</span>: <span class='ec-lmtt-10'>EC 06 08 00 00 00 00 00 00 00 00 00 00 00 00 00</span><br class='newline' /><span class='ec-lmtt-10'>Cpuid1Mask</span>: <span class='ec-lmtt-10'>FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00</span>
         </li>
         <li class='itemize'>Rocket Lake (<span class='ec-lmtt-10'>0x0A0670</span>) to Comet Lake (<span class='ec-lmtt-10'>0x0A0655</span>):<br class='newline' /><span class='ec-lmtt-10'>Cpuid1Data</span>: <span class='ec-lmtt-10'>55 06 0A 00 00 00 00 00 00 00 00 00 00 00 00 00</span><br class='newline' /><span class='ec-lmtt-10'>Cpuid1Mask</span>: <span class='ec-lmtt-10'>FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00</span>
         </li>
         <li class='itemize'>Alder Lake (<span class='ec-lmtt-10'>0x090672</span>) to Comet Lake (<span class='ec-lmtt-10'>0x0A0655</span>):<br class='newline' /><span class='ec-lmtt-10'>Cpuid1Data</span>: <span class='ec-lmtt-10'>55 06 0A 00 00 00 00 00 00 00 00 00 00 00 00 00</span><br class='newline' /><span class='ec-lmtt-10'>Cpuid1Mask</span>: <span class='ec-lmtt-10'>FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00</span></li></ul>
     <!-- l. 2252 --><p class='noindent'><span class='ec-lmri-10'>Note 4</span>: Be aware that the following configurations are unsupported by XCPM (at least out of the box):
</p>
         <ul class='itemize1'>
         <li class='itemize'>Consumer Ivy Bridge (<span class='ec-lmtt-10'>0x0306A9</span>) as Apple disabled XCPM for Ivy Bridge and recommends legacy power
         management for these CPUs. <span class='ec-lmtt-10'>_xcpm_bootstrap </span>should manually be patched to enforce XCPM on these
         CPUs instead of this option.
         </li>
         <li class='itemize'>Low-end CPUs (e.g. Haswell+ Pentium) as they are not supported properly by macOS. Legacy workarounds
         for older models can be found in the <span class='ec-lmtt-10'>Special NOTES </span>section of <a href='https://github.com/acidanthera/bugtracker/issues/365'>acidanthera/bugtracker#365</a>.</li></ul>
     </li>
<li class='enumerate' id='x1-36004x2'>
     <!-- l. 2265 --><p class='noindent'><span class='ec-lmtt-10'>Cpuid1Mask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 16 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Bit mask of active bits in <span class='ec-lmtt-10'>Cpuid1Data</span>.
     </p><!-- l. 2270 --><p class='noindent'>When each <span class='ec-lmtt-10'>Cpuid1Mask </span>bit is set to 0, the original CPU bit is used, otherwise set bits take the value of
     <span class='ec-lmtt-10'>Cpuid1Data</span>.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-36006x3'>
     <!-- l. 2274 --><p class='noindent'><span class='ec-lmtt-10'>DummyPowerManagement</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4-12<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables <span class='ec-lmtt-10'>AppleIntelCpuPowerManagement</span>.
     </p><!-- l. 2280 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This option is a preferred alternative to <span class='ec-lmtt-10'>NullCpuPowerManagement.kext </span>for CPUs without native power
     management driver in macOS.
     </p><!-- l. 2284 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: While this option is typically needed to disable <span class='ec-lmtt-10'>AppleIntelCpuPowerManagement </span>on unsupported platforms, it
     can also be used to disable this kext in other situations (e.g. with <span class='ec-lmtt-10'>Cpuid1Data </span>left blank).
     </p></li>
<li class='enumerate' id='x1-36008x4'>
     <!-- l. 2289 --><p class='noindent'><span class='ec-lmtt-10'>MaxKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Emulates CPUID and applies <span class='ec-lmtt-10'>DummyPowerManagement </span>on specified macOS version or older.
     </p><!-- l. 2294 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-36010x5'>
     <!-- l. 2297 --><p class='noindent'><span class='ec-lmtt-10'>MinKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Emulates CPUID and applies <span class='ec-lmtt-10'>DummyPowerManagement </span>on specified macOS version or newer.
     </p><!-- l. 2302 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
</p>
     </li></ol>
<!-- l. 2306 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='force-properties'><span class='titlemark'>7.6   </span> <a id='x1-370007.6'></a>Force Properties</h4>
<!-- l. 2308 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-37002x1'><span class='ec-lmtt-10'>Arch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Apply to any supported architecture)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>x86_64</span>).
     </li>
<li class='enumerate' id='x1-37004x2'><span class='ec-lmtt-10'>BundlePath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext bundle path (e.g. <span class='ec-lmtt-10'>System\Library \Extensions \IONetworkingFamily.kext</span>).
     </li>
<li class='enumerate' id='x1-37006x3'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-37008x4'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to load this kernel extension from the system volume when not present in the kernel
     cache.
     </li>
<li class='enumerate' id='x1-37010x5'><span class='ec-lmtt-10'>ExecutablePath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext executable path relative to bundle (e.g. <span class='ec-lmtt-10'>Contents/MacOS/IONetworkingFamily</span>).
     </li>
<li class='enumerate' id='x1-37012x6'><span class='ec-lmtt-10'>Identifier</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>:       Kext       identifier       to       perform       presence       checking       before       adding
     (e.g. <span class='ec-lmtt-10'>com.apple.iokit.IONetworkingFamily</span>). Only drivers which identifiers are not be found in the cache will
     be added.
     </li>
<li class='enumerate' id='x1-37014x7'>
     <!-- l. 2352 --><p class='noindent'><span class='ec-lmtt-10'>MaxKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Adds kernel extension on specified macOS version or older.
     </p><!-- l. 2357 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-37016x8'>
     <!-- l. 2360 --><p class='noindent'><span class='ec-lmtt-10'>MinKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Adds kernel extension on specified macOS version or newer.
     </p><!-- l. 2365 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-37018x9'><span class='ec-lmtt-10'>PlistPath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext <span class='ec-lmtt-10'>Info.plist </span>path relative to bundle (e.g. <span class='ec-lmtt-10'>Contents/Info.plist</span>).
</li></ol>
<!-- l. 2377 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='patch-properties2'><span class='titlemark'>7.7   </span> <a id='x1-380007.7'></a>Patch Properties</h4>
<!-- l. 2379 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-38002x1'><span class='ec-lmtt-10'>Arch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Any </span>(Apply to any supported architecture)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext patch architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>x86_64</span>).
     </li>
<li class='enumerate' id='x1-38004x2'><span class='ec-lmtt-10'>Base</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Selects symbol-matched base for patch lookup (or immediate replacement) by obtaining the address
     of the provided symbol name.
     </li>
<li class='enumerate' id='x1-38006x3'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-38008x4'><span class='ec-lmtt-10'>Count</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of patch occurrences to apply. <span class='ec-lmtt-10'>0 </span>applies the patch to all occurrences found.
     </li>
<li class='enumerate' id='x1-38010x5'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: This kernel patch will not be used unless set to <span class='ec-lmtt-10'>true</span>.
     </li>
<li class='enumerate' id='x1-38012x6'><span class='ec-lmtt-10'>Find</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Immediate replacement at <span class='ec-lmtt-10'>Base</span>)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data to find. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-38014x7'><span class='ec-lmtt-10'>Identifier</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Kext bundle identifier (e.g. <span class='ec-lmtt-10'>com.apple.driver.AppleHDA</span>) or <span class='ec-lmtt-10'>kernel </span>for kernel patch.
     </li>
<li class='enumerate' id='x1-38016x8'><span class='ec-lmtt-10'>Limit</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Search entire kext or kernel)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Maximum number of bytes to search for.
     </li>
<li class='enumerate' id='x1-38018x9'><span class='ec-lmtt-10'>Mask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during find comparison. Allows fuzzy search by ignoring not masked (set
     to zero) bits. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-38020x10'>
     <!-- l. 2443 --><p class='noindent'><span class='ec-lmtt-10'>MaxKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Patches data on specified macOS version or older.
     </p><!-- l. 2448 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-38022x11'>
     <!-- l. 2451 --><p class='noindent'><span class='ec-lmtt-10'>MinKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Patches data on specified macOS version or newer.
     </p><!-- l. 2456 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Refer to the <a href='#kernmatch'><span class='ec-lmtt-10'>Add MaxKernel </span>description</a> for matching logic.
     </p></li>
<li class='enumerate' id='x1-38024x12'><span class='ec-lmtt-10'>Replace</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replacement data of one or more bytes.
     </li>
<li class='enumerate' id='x1-38026x13'><span class='ec-lmtt-10'>ReplaceMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Ignored)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Data bitwise mask used during replacement. Allows fuzzy replacement by updating masked (set
     to non-zero) bits. Must be equal to <span class='ec-lmtt-10'>Replace </span>in size if set.
     </li>
<li class='enumerate' id='x1-38028x14'><span class='ec-lmtt-10'>Skip</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Do not skip any occurrences)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Number of found occurrences to skip before replacements are applied.
</li></ol>
<!-- l. 2481 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='quirks-properties2'><span class='titlemark'>7.8   </span> <a id='x1-390007.8'></a>Quirks Properties</h4>
<!-- l. 2483 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-39002x1'>
     <!-- l. 2486 --><p class='noindent'><span class='ec-lmtt-10'>AppleCpuPmCfgLock</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4-12<br class='newline' /><span class='ec-lmbx-10'>Description</span>:                 Disables                 <span class='ec-lmtt-10'>PKG_CST_CONFIG_CONTROL           </span>(<span class='ec-lmtt-10'>0xE2</span>)                 MSR
     modification in AppleIntelCPUPowerManagement.kext, commonly causing early kernel panic, when it is locked
     from writing.
     </p><!-- l. 2494 --><p class='noindent'>Some types of firmware lock the <span class='ec-lmtt-10'>PKG_CST_CONFIG_CONTROL </span>MSR register and the bundled <span class='ec-lmtt-10'>ControlMsrE2 </span>tool
     can be used to check its state. Note that some types of firmware only have this register locked on some cores.
     As modern firmware provide a <span class='ec-lmtt-10'>CFG Lock </span>setting that allows configuring the <span class='ec-lmtt-10'>PKG_CST_CONFIG_CONTROL </span>MSR
     register lock, this option should be avoided whenever possible.
     </p><!-- l. 2501 --><p class='noindent'>On APTIO firmware that do not provide a <span class='ec-lmtt-10'>CFG Lock </span>setting in the GUI, it is possible to access the option
     directly:
     </p><!-- l. 2504 --><p class='noindent'>
         </p><ol class='enumerate2'>
<li class='enumerate' id='x1-39004x1'>Download <a href='https://github.com/LongSoft/UEFITool/releases'>UEFITool</a> and <a href='https://github.com/LongSoft/Universal-IFR-Extractor/releases'>IFR-Extractor</a>.
         </li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-39006x2'>Open the firmware image in UEFITool and find <span class='ec-lmtt-10'>CFG Lock </span>unicode string. If it is not present, the firmware
         may not have this option and the process should therefore be discontinued.
         </li>
<li class='enumerate' id='x1-39008x3'>Extract the <span class='ec-lmtt-10'>Setup.bin </span>PE32 Image Section (the UEFITool found) through the <span class='ec-lmtt-10'>Extract Body </span>menu option.
         </li>
<li class='enumerate' id='x1-39010x4'>Run IFR-Extractor on the extracted file (e.g. <span class='ec-lmtt-10'>./ifrextract Setup.bin Setup.txt</span>).
         </li>
<li class='enumerate' id='x1-39012x5'>Find <span class='ec-lmtt-10'>CFG Lock, VarStoreInfo (VarOffset/VarName): </span>in <span class='ec-lmtt-10'>Setup.txt </span>and remember the offset right after
         it (e.g. <span class='ec-lmtt-10'>0x123</span>).
         </li>
<li class='enumerate' id='x1-39014x6'>Download and run <a href='http://brains.by/posts/bootx64.7z'>Modified GRUB Shell</a> compiled by <a href='https://geektimes.com/post/258090'>brainsucker</a> or use <a href='https://github.com/datasone/grub-mod-setup_var'>a newer version</a> by <a href='https://github.com/datasone'>datasone</a>.
         </li>
<li class='enumerate' id='x1-39016x7'>Enter <span class='ec-lmtt-10'>setup_var 0x123 0x00 </span>command, where <span class='ec-lmtt-10'>0x123 </span>should be replaced by the actual offset, and reboot.</li></ol>
     <!-- l. 2523 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: Variable offsets are unique not only to each motherboard but even to its firmware version. Never ever try to
     use an offset without checking.
     </p><!-- l. 2526 --><p class='noindent'>On selected platforms, the <span class='ec-lmtt-10'>ControlMsrE2 </span>tool can also change such hidden options. Pass desired argument: <span class='ec-lmtt-10'>lock</span>, <span class='ec-lmtt-10'>unlock</span>
     for <span class='ec-lmtt-10'>CFG Lock</span>. Or pass <span class='ec-lmtt-10'>interactive </span>to find and modify other hidden options.
     </p><!-- l. 2531 --><p class='noindent'>As a last resort, consider <a href='https://github.com/LongSoft/UEFITool/blob/master/UEFIPatch/patches.txt'>patching the BIOS</a> (for advanced users only).
     </p></li>
<li class='enumerate' id='x1-39018x2'>
     <!-- l. 2536 --><p class='noindent'><span class='ec-lmtt-10'>AppleXcpmCfgLock</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables <span class='ec-lmtt-10'>PKG_CST_CONFIG_CONTROL </span>(<span class='ec-lmtt-10'>0xE2</span>) MSR modification in XNU kernel, commonly causing early
     kernel panic, when it is locked from writing (XCPM power management).
     </p><!-- l. 2544 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option should be avoided whenever possible. Refer to the <span class='ec-lmtt-10'>AppleCpuPmCfgLock </span>description for
     details.
     </p></li>
<li class='enumerate' id='x1-39020x3'>
     <!-- l. 2548 --><p class='noindent'><span class='ec-lmtt-10'>AppleXcpmExtraMsrs</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables multiple MSR access critical for certain CPUs, which have no native XCPM support.
     </p><!-- l. 2555 --><p class='noindent'>This is typically used in conjunction with the <span class='ec-lmtt-10'>Emulate </span>section on Haswell-E, Broadwell-E, Skylake-SP, and similar CPUs.
     More details on the XCPM patches are outlined in <a href='https://github.com/acidanthera/bugtracker/issues/365'>acidanthera/bugtracker#365</a>.
     </p><!-- l. 2559 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Additional not provided patches will be required for Ivy Bridge or Pentium CPUs. It is recommended to use
     <span class='ec-lmtt-10'>AppleIntelCpuPowerManagement.kext </span>for the former.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-39022x4'>
     <!-- l. 2563 --><p class='noindent'><span class='ec-lmtt-10'>AppleXcpmForceBoost</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Forces maximum performance in XCPM mode.
     </p><!-- l. 2569 --><p class='noindent'>This patch writes <span class='ec-lmtt-10'>0xFF00 </span>to <span class='ec-lmtt-10'>MSR_IA32_PERF_CONTROL </span>(<span class='ec-lmtt-10'>0x199</span>), effectively setting maximum multiplier for all the
     time.
     </p><!-- l. 2572 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: While this may increase the performance, this patch is strongly discouraged on all systems but those
     explicitly dedicated to scientific or media calculations. Only certain Xeon models typically benefit from the
     patch.
     </p></li>
<li class='enumerate' id='x1-39024x5'>
     <!-- l. 2577 --><p class='noindent'><span class='ec-lmtt-10'>CustomPciSerialDevice</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.7<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Performs change of PMIO register base address on a customised PCI serial device.
     </p><!-- l. 2584 --><p class='noindent'>The patch changes the PMIO register base address that the XNU kernel uses for serial input and output, from that of the
     default built-in COM1 serial port <span class='ec-lmtt-10'>0x3F8</span>, to the base address stored in the first IO BAR of a specified PCI device or to a
     specific base address (e.g. <span class='ec-lmtt-10'>0x2F8 </span>for COM2).
     </p><!-- l. 2588 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: By default, serial logging is disabled. <span class='ec-lmtt-10'>serial=3 </span>boot argument, which enables serial input and output, should be
     used for XNU to print logs to the serial port.
     </p><!-- l. 2591 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: In addition to this patch, kext <span class='ec-lmtt-10'>Apple16X50PCI0 </span>should be prevented from attaching to have <span class='ec-lmtt-10'>kprintf </span>method
     working properly. This can be achieved by setting (i.e. <span class='ec-lmtt-10'>Delete</span>, then <span class='ec-lmtt-10'>Add</span>) the <span class='ec-lmtt-10'>class-code </span>property of the PCI serial port
     device to <span class='ec-lmtt-10'>FFFFFFFF </span>in <span class='ec-lmtt-10'>DeviceProperties </span>section. As an alternative solution, a codeless kext <span class='ec-lmtt-10'>PCIeSerialDisable.kext</span>
     shown in the spoiler <span class='ec-lmtt-10'>PCIeSerialDisable.kext/Contents/Info.plist </span>at <a href='https://github.com/acidanthera/bugtracker/issues/1954'>acidanthera/bugtracker#1954</a>, may also be
     used. In addition, for certain Thunderbolt cards the IOKit personality <span class='ec-lmtt-10'>IOPCITunnelCompatible </span>also
     needs to be set to <span class='ec-lmtt-10'>true</span>, which can be done by the <span class='ec-lmtt-10'>PCIeSerialThunderboltEnable.kext </span>attached at
     <a href='https://github.com/acidanthera/bugtracker/issues/2003#issuecomment-1116761087'>acidanthera/bugtracker#2003</a>.
     </p><!-- l. 2600 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: For this patch to be correctly applied, <span class='ec-lmtt-10'>Override </span>must be enabled with all keys properly set in <span class='ec-lmtt-10'>Custom</span>, under
     section <span class='ec-lmtt-10'>Misc-&gt;Serial</span>.
     </p><!-- l. 2603 --><p class='noindent'><span class='ec-lmri-10'>Note 4</span>: This patch is for PMIO support and is therefore not applied if <span class='ec-lmtt-10'>UseMmio </span>under section <span class='ec-lmtt-10'>Misc-&gt;Serial-&gt;Custom </span>is
     false. For MMIO, there are boot arguments <span class='ec-lmtt-10'>pcie_mmio_uart=ADDRESS </span>and <span class='ec-lmtt-10'>mmio_uart=ADDRESS </span>that allow the kernel to
     use MMIO for serial port access.
     </p><!-- l. 2606 --><p class='noindent'><span class='ec-lmri-10'>Note 5</span>: The serial baud rate must be correctly set in both <span class='ec-lmtt-10'>BaudRate </span>under section <span class='ec-lmtt-10'>Misc-&gt;Serial-&gt;Custom </span>and via
     <span class='ec-lmtt-10'>serialbaud=VALUE </span>boot argument, both of which should match against each other. The default baud rate is
     <span class='ec-lmtt-10'>115200</span>.
     </p></li>
<li class='enumerate' id='x1-39026x6'><span class='ec-lmtt-10'>CustomSMBIOSGuid</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Performs GUID patching for <span class='ec-lmtt-10'>UpdateSMBIOSMode Custom </span>mode. Usually relevant for Dell
     laptops.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-39028x7'>
     <!-- l. 2618 --><p class='noindent'><span class='ec-lmtt-10'>DisableIoMapper</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables <span class='ec-lmtt-10'>IOMapper </span>support in XNU (VT-d), which may conflict with the firmware implementation.
     </p><!-- l. 2625 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This option is a preferred alternative to deleting <span class='ec-lmtt-10'>DMAR </span>ACPI table and disabling VT-d in firmware preferences,
     which does not obstruct VT-d support in other systems in case they need this.
     </p><!-- l. 2629 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Misconfigured IOMMU in the firmware may result in broken devices such as ethernet or Wi-Fi adapters. For
     instance, an ethernet adapter may cycle in link-up link-down state infinitely and a Wi-Fi adapter may fail to discover
     networks. Gigabyte is one of the most common OEMs with these issues.
     </p></li>
<li class='enumerate' id='x1-39030x8'>
     <!-- l. 2635 --><p class='noindent'><span class='ec-lmtt-10'>DisableLinkeditJettison</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 11<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables <span class='ec-lmtt-10'>__LINKEDIT </span>jettison code.
     </p><!-- l. 2641 --><p class='noindent'>This option lets <span class='ec-lmtt-10'>Lilu.kext</span>, and possibly other kexts, function in macOS Big Sur at their best performance levels
     without requiring the <span class='ec-lmtt-10'>keepsyms=1 </span>boot argument.
     </p></li>
<li class='enumerate' id='x1-39032x9'>
     <!-- l. 2646 --><p class='noindent'><span class='ec-lmtt-10'>DisableRtcChecksum</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables primary checksum (<span class='ec-lmtt-10'>0x58</span>-<span class='ec-lmtt-10'>0x59</span>) writing in AppleRTC.
     </p><!-- l. 2653 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This option will not protect other areas from being overwritten, see <a href='https://github.com/acidanthera/RTCMemoryFixup'>RTCMemoryFixup</a> kernel extension if this is
     desired.
     </p><!-- l. 2657 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: This option will not protect areas from being overwritten at firmware stage (e.g. macOS bootloader), see
     <span class='ec-lmtt-10'>AppleRtcRam </span>protocol description if this is desired.
     </p></li>
<li class='enumerate' id='x1-39034x10'>
     <!-- l. 2662 --><p class='noindent'><span class='ec-lmtt-10'>ExtendBTFeatureFlags</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8-11<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set <span class='ec-lmtt-10'>FeatureFlags </span>to <span class='ec-lmtt-10'>0x0F </span>for full functionality of Bluetooth, including Continuity.
     </p><!-- l. 2669 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option is a substitution for BT4LEContinuityFixup.kext, which does not function properly due to late
     patching progress.
     </p></li>
<li class='enumerate' id='x1-39036x11'>
     <!-- l. 2673 --><p class='noindent'><span class='ec-lmtt-10'>ExternalDiskIcons</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply icon type patches to AppleAHCIPort.kext to force internal disk icons for all AHCI
     disks.
     </p><!-- l. 2680 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option should be avoided whenever possible. Modern firmware typically have compatible AHCI
     controllers.
     </p></li>
<li class='enumerate' id='x1-39038x12'>
     <!-- l. 2684 --><p class='noindent'><span class='ec-lmtt-10'>ForceAquantiaEthernet</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.15.4<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable Aquantia AQtion based 10GbE network cards support.
     </p><!-- l. 2690 --><p class='noindent'>This option enables Aquantia AQtion based 10GbE network cards support, which used to work natively before macOS
     10.15.4.
     </p><!-- l. 2693 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: In order for Aquantia cards to properly function, <span class='ec-lmtt-10'>DisableIoMapper </span>must be disabled, <span class='ec-lmtt-10'>DMAR </span>ACPI table must not
     be dropped, and <span class='ec-lmtt-10'>VT-d </span>must be enabled in BIOS.
     </p><!-- l. 2697 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: While this patch should enable ethernet support for all Aquantia AQtion series, it has only been tested on
     AQC-107s based 10GbE network cards.
     </p><!-- l. 2700 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: To address <span class='ec-lmtt-10'>AppleVTD </span>incompatibilities after applying this quirk, the <span class='ec-lmtt-10'>Reserved Memory Region </span>section of the
     corresponding device in the <span class='ec-lmtt-10'>DMAR </span>ACPI table might be removed. This table should be disassembled and edited, then
     recompiled to <span class='ec-lmtt-10'>AML </span>with tool <span class='ec-lmtt-10'>iASL</span>. For the patched <span class='ec-lmtt-10'>DMAR </span>table to be <a href='#add-properties'>added</a>, the original one should be <a href='#delete-properties'>deleted</a>. More
     details can be found at <a href='https://github.com/acidanthera/OpenCorePkg/commit/24414555f2c07e06a3674ec7a2aa1ce4860bbcc7#commitcomment-70530145'>comment on commit 2441455</a>.
     </p></li>
<li class='enumerate' id='x1-39040x13'>
     <!-- l. 2709 --><p class='noindent'><span class='ec-lmtt-10'>ForceSecureBootScheme</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 11<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Force <span class='ec-lmtt-10'>x86 </span>scheme for IMG4 verification.
     </p><!-- l. 2715 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option is required on virtual machines when using <span class='ec-lmtt-10'>SecureBootModel </span>different from <span class='ec-lmtt-10'>x86legacy</span>.
     </p></li>
<li class='enumerate' id='x1-39042x14'>
     <!-- l. 2719 --><p class='noindent'><span class='ec-lmtt-10'>IncreasePciBarSize</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.10<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Allows IOPCIFamily to boot with 2 GB PCI BARs.
     </p><!-- l. 2725 --><p class='noindent'>Normally macOS restricts PCI BARs to 1 GB. Enabling this option (still) does not let macOS actually use PCI devices
     with larger BARs.
     </p><!-- l. 2728 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option should be avoided whenever possible. A need for this option indicates misconfigured or defective
     firmware.
     </p></li>
<li class='enumerate' id='x1-39044x15'><span class='ec-lmtt-10'>LapicKernelPanic</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.6 (64-bit)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables kernel panic on LAPIC interrupts.
     </li>
<li class='enumerate' id='x1-39046x16'><span class='ec-lmtt-10'>LegacyCommpage</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.4 - 10.6<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the default 64-bit commpage bcopy implementation with one that does not require SSSE3, useful
     for legacy platforms. This prevents a <span class='ec-lmtt-10'>commpage no match for last </span>panic due to no available 64-bit bcopy functions
     that do not require SSSE3.
     </li>
<li class='enumerate' id='x1-39048x17'><span class='ec-lmtt-10'>PanicNoKextDump</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.13 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Prevent kernel from printing kext dump in the panic log preventing from observing panic details. Affects
     10.13 and above.
     </li>
<li class='enumerate' id='x1-39050x18'>
     <!-- l. 2757 --><p class='noindent'><span class='ec-lmtt-10'>PowerTimeoutKernelPanic</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.15 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disables kernel panic on setPowerState timeout.
     </p><!-- l. 2763 --><p class='noindent'>An additional security measure was added to macOS Catalina (10.15) causing kernel panic on power change timeout for
     Apple drivers. Sometimes it may cause issues on misconfigured hardware, notably digital audio, which sometimes fails to
     wake up. For debug kernels <span class='ec-lmtt-10'>setpowerstate_panic=0 </span>boot argument should be used, which is otherwise equivalent to this
     quirk.
     </p></li>
<li class='enumerate' id='x1-39052x19'>
     <!-- l. 2770 --><p class='noindent'><span class='ec-lmtt-10'>ProvideCurrentCpuInfo</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.8 (10.14)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provides current CPU info to the kernel.
     </p><!-- l. 2776 --><p class='noindent'>This quirk works differently depending on the CPU:
</p>
         <ul class='itemize1'>
         <li class='itemize'>For Microsoft Hyper-V it provides the correct TSC and FSB values to the kernel, as well as disables CPU
         topology validation (10.8+).
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'>For KVM and other hypervisors it provides precomputed MSR 35h values solving kernel panic with <span class='ec-lmtt-10'>-cpu
         </span><span class='ec-lmtt-10'>host</span>.
         </li>
         <li class='itemize'>For Intel CPUs it adds support for asymmetrical SMP systems (e.g. Intel Alder Lake) by patching core
         count to thread count along with the supplemental required changes (10.14+).</li></ul>
     </li>
<li class='enumerate' id='x1-39054x20'>
     <!-- l. 2790 --><p class='noindent'><span class='ec-lmtt-10'>SetApfsTrimTimeout</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.14 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set trim timeout in microseconds for APFS filesystems on SSDs.
     </p><!-- l. 2796 --><p class='noindent'>The APFS filesystem is designed in a way that the space controlled via the spaceman structure is either used or free.
     This may be different in other filesystems where the areas can be marked as used, free, and <span class='ec-lmri-10'>unmapped</span>. All free
     space is trimmed (unmapped/deallocated) at macOS startup. The trimming procedure for NVMe drives
     happens in LBA ranges due to the nature of the <span class='ec-lmtt-10'>DSM </span>command with up to 256 ranges per command.
     The more fragmented the memory on the drive is, the more commands are necessary to trim all the free
     space.
     </p><!-- l. 2806 --><p class='noindent'>Depending on the SSD controller and the level of drive fragmenation, the trim procedure may take a considerable amount
     of time, causing noticeable boot slowdown. The APFS driver explicitly ignores previously unmapped areas and
     repeatedly trims them on boot. To mitigate against such boot slowdowns, the macOS driver introduced a timeout
     (<span class='ec-lmtt-10'>9.999999 </span>seconds) that stops the trim operation when not finished in time.
     </p><!-- l. 2813 --><p class='noindent'>On several controllers, such as Samsung, where the deallocation process is relatively slow, this timeout can be reached
     very quickly. Essentially, it means that the level of fragmentation is high, thus macOS will attempt to trim the same
     lower blocks that have previously been deallocated, but never have enough time to deallocate higher blocks. The outcome
     is that trimming on such SSDs will be non-functional soon after installation, resulting in additional wear on the
     flash.
     </p><!-- l. 2820 --><p class='noindent'>One way to workaround the problem is to increase the timeout to an extremely high value, which at the cost of slow boot
     times (extra minutes) will ensure that all the blocks are trimmed. Setting this option to a high value, such as <span class='ec-lmtt-10'>4294967295</span>
     ensures that all blocks are trimmed. Alternatively, use over-provisioning, if supported, or create a dedicated unmapped
     partition where the reserve blocks can be found by the controller. Conversely, the trim operation can be
     mostly disabled by setting a very low timeout value, while <span class='ec-lmtt-10'>0 </span>entirely disables it. Refer to this <a href='https://interface31.ru/tech_it/2015/04/mozhno-li-effektivno-ispolzovat-ssd-bez-podderzhki-trim.html'>article</a> for
     details.
     </p><!-- l. 2831 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The failsafe value <span class='ec-lmtt-10'>-1 </span>indicates that this patch will not be applied, such that <span class='ec-lmtt-10'>apfs.kext </span>will remain
     untouched.
     </p><!-- l. 2834 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: On macOS 12.0 and above, it is no longer possible to specify trim timeout. However, it can be disabled by setting
     <span class='ec-lmtt-10'>0</span>.
     </p><!-- l. 2837 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: Trim operations are <span class='ec-lmri-10'>only </span>affected at booting phase when the startup volume is mounted. Either specifying
     timeout, or completely disabling trim with <span class='ec-lmtt-10'>0</span>, will not affect normal macOS running.
     </p></li>
<li class='enumerate' id='x1-39056x21'>
     <!-- l. 2841 --><p class='noindent'><span class='ec-lmtt-10'>ThirdPartyDrives</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.6 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply vendor patches to IOAHCIBlockStorage.kext to enable native features for third-party drives, such
     as TRIM on SSDs or hibernation support on 10.15 and newer.
                                                                                                  
                                                                                                  
     </p><!-- l. 2849 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option may be avoided on user preference. NVMe SSDs are compatible without the change. For AHCI SSDs
     on modern macOS version there is a dedicated built-in utility called <span class='ec-lmtt-10'>trimforce</span>. Starting from 10.15
     this utility creates <span class='ec-lmtt-10'>EnableTRIM </span>variable in <span class='ec-lmtt-10'>APPLE_BOOT_VARIABLE_GUID </span>namespace with <span class='ec-lmtt-10'>01 00 00 00</span>
     value.
     </p></li>
<li class='enumerate' id='x1-39058x22'>
     <!-- l. 2856 --><p class='noindent'><span class='ec-lmtt-10'>XhciPortLimit</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Requirement</span>: 10.11 (not required for older)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Patch various kexts (AppleUSBXHCI.kext, AppleUSBXHCIPCI.kext, IOUSBHostFamily.kext) to remove
     USB port count limit of 15 ports.
     </p><!-- l. 2863 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option should be avoided whenever possible. USB port limit is imposed by the amount of used bits in
     locationID format and there is no possible way to workaround this without heavy OS modification. The only
     valid solution is to limit the amount of used ports to 15 (discarding some). More details can be found on
     <a href='https://applelife.ru/posts/550233'>AppleLife.ru</a>.
</p>
     </li></ol>
<!-- l. 2871 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='scheme-properties'><span class='titlemark'>7.9   </span> <a id='x1-400007.9'></a>Scheme Properties</h4>
<!-- l. 2873 --><p class='noindent'>These properties are particularly relevant for older macOS operating systems. Refer to the <a href='#legacy-apple-os'>Legacy Apple OS</a> section for details
on how to install and troubleshoot such macOS installations.
</p><!-- l. 2877 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-40002x1'>
     <!-- l. 2879 --><p class='noindent'><span class='ec-lmtt-10'>CustomKernel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Use customised kernel cache from the <span class='ec-lmtt-10'>Kernels </span>directory located at the root of the ESP partition.
     </p><!-- l. 2885 --><p class='noindent'>Unsupported platforms including <span class='ec-lmtt-10'>Atom </span>and <span class='ec-lmtt-10'>AMD </span>require modified versions of XNU kernel in order to boot. This
     option provides the possibility to using a customised kernel cache which contains such modifications from ESP
     partition.
     </p></li>
<li class='enumerate' id='x1-40004x2'>
     <!-- l. 2890 --><p class='noindent'><span class='ec-lmtt-10'>FuzzyMatch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Use <span class='ec-lmtt-10'>kernelcache </span>with different checksums when available.
     </p><!-- l. 2895 --><p class='noindent'>On macOS 10.6 and earlier, <span class='ec-lmtt-10'>kernelcache </span>filename has a checksum, which essentially is <span class='ec-lmtt-10'>adler32 </span>from SMBIOS
     product name and EfiBoot device path. On certain firmware, the EfiBoot device path differs between UEFI and
     macOS due to ACPI or hardware specifics, rendering <span class='ec-lmtt-10'>kernelcache </span>checksum as always different.
     </p><!-- l. 2900 --><p class='noindent'>This setting allows matching the latest <span class='ec-lmtt-10'>kernelcache </span>with a suitable architecture when the <span class='ec-lmtt-10'>kernelcache </span>without
     suffix is unavailable, improving macOS 10.6 boot performance on several platforms.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-40006x3'>
     <!-- l. 2905 --><p class='noindent'><span class='ec-lmtt-10'>KernelArch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto </span>(Choose the preferred architecture automatically)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Prefer specified kernel architecture (<span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>i386-user32</span>, <span class='ec-lmtt-10'>x86_64</span>) when available.
     </p><!-- l. 2911 --><p class='noindent'>On macOS 10.7 and earlier, the XNU kernel can boot with architectures different from the usual <span class='ec-lmtt-10'>x86_64</span>. This
     setting will use the specified architecture to boot macOS when it is supported by the macOS and the configuration:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>i386 </span>— Use <span class='ec-lmtt-10'>i386 </span>(32-bit) kernel when available.
         </li>
         <li class='itemize'>
         <!-- l. 2918 --><p class='noindent'><span class='ec-lmtt-10'>i386-user32 </span>— Use <span class='ec-lmtt-10'>i386 </span>(32-bit) kernel when available and force the use of 32-bit userspace on 64-bit capable
         processors if supported by the operating system. </p>
             <ul class='itemize2'>
             <li class='itemize'>On macOS, 64-bit capable processors are assumed to support <span class='ec-lmtt-10'>SSSE3</span>. This is not the case for older 64-bit
             capable Pentium processors, which cause some applications to crash on macOS 10.6. This behaviour
             corresponds to the <span class='ec-lmtt-10'>-legacy </span>kernel boot argument.
             </li>
             <li class='itemize'>This  option  is  unavailable  on  macOS 10.4  and  10.5  when  running  on  64-bit  firmware  due  to  an
             uninitialised 64-bit segment in the XNU kernel, which causes AppleEFIRuntime to incorrectly execute
             64-bit code as 16-bit code.</li></ul>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>x86_64 </span>— Use <span class='ec-lmtt-10'>x86_64 </span>(64-bit) kernel when available.</li></ul>
     <!-- l. 2934 --><p class='noindent'>The algorithm used to determine the preferred kernel architecture is set out below.
     </p><!-- l. 2936 --><p class='noindent'>
         </p><ol class='enumerate2'>
<li class='enumerate' id='x1-40008x1'><span class='ec-lmtt-10'>arch </span>argument in image arguments (e.g. when launched via UEFI Shell) or in <span class='ec-lmtt-10'>boot-args </span>variable overrides
         any compatibility checks and forces the specified architecture, completing this algorithm.
         </li>
<li class='enumerate' id='x1-40010x2'>OpenCore build architecture restricts capabilities to <span class='ec-lmtt-10'>i386 </span>and <span class='ec-lmtt-10'>i386-user32 </span>mode for the 32-bit firmware
         variant.
         </li>
<li class='enumerate' id='x1-40012x3'>
         <!-- l. 2943 --><p class='noindent'>Determined EfiBoot version restricts architecture choice: </p>
             <ul class='itemize1'>
             <li class='itemize'>10.4-10.5 — <span class='ec-lmtt-10'>i386 </span>or <span class='ec-lmtt-10'>i386-user32 </span>(only on 32-bit firmware)
             </li>
             <li class='itemize'>10.6 — <span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>i386-user32</span>, or <span class='ec-lmtt-10'>x86_64</span>
             </li>
                                                                                                  
                                                                                                  
             <li class='itemize'>10.7 — <span class='ec-lmtt-10'>i386 </span>or <span class='ec-lmtt-10'>x86_64</span>
             </li>
             <li class='itemize'>10.8 or newer — <span class='ec-lmtt-10'>x86_64</span></li></ul>
         </li>
<li class='enumerate' id='x1-40014x4'>If <span class='ec-lmtt-10'>KernelArch </span>is set to <span class='ec-lmtt-10'>Auto </span>and <span class='ec-lmtt-10'>SSSE3 </span>is not supported by the CPU, capabilities are restricted to <span class='ec-lmtt-10'>i386-user32 </span>if
         supported by EfiBoot.
         </li>
<li class='enumerate' id='x1-40016x5'>Board identifier (from SMBIOS) based on EfiBoot version disables <span class='ec-lmtt-10'>x86_64 </span>support on an unsupported
         model if any <span class='ec-lmtt-10'>i386 </span>variant is supported. <span class='ec-lmtt-10'>Auto </span>is not consulted here as the list is not overridable in
         EfiBoot.
         </li>
<li class='enumerate' id='x1-40018x6'><span class='ec-lmtt-10'>KernelArch </span>restricts the support to the explicitly specified architecture (when not set to <span class='ec-lmtt-10'>Auto</span>) if the architecture
         remains present in the capabilities.
         </li>
<li class='enumerate' id='x1-40020x7'>The best supported architecture is chosen in this order: <span class='ec-lmtt-10'>x86_64</span>, <span class='ec-lmtt-10'>i386</span>, <span class='ec-lmtt-10'>i386-user32</span>.</li></ol>
     <!-- l. 2964 --><p class='noindent'>Unlike macOS 10.7 (where certain board identifiers are treated as the <span class='ec-lmtt-10'>i386 </span>only machines), and macOS 10.5 or earlier
     (where <span class='ec-lmtt-10'>x86_64 </span>is not supported by the macOS kernel), macOS 10.6 is very special. The architecture choice on
     macOS 10.6 depends on many factors including not only the board identifier, but also the macOS product type (client vs
     server), macOS point release, and amount of RAM. The detection of all these is complicated and impractical, as several
     point releases had implementation flaws resulting in a failure to properly execute the server detection in the first place.
     For this reason, OpenCore on macOS 10.6 falls back on the <span class='ec-lmtt-10'>x86_64 </span>architecture whenever it is supported by the board,
     as it is on macOS 10.7.
     </p><!-- l. 2974 --><p class='noindent'>A 64-bit Mac model compatibility matrix corresponding to actual EfiBoot behaviour on macOS 10.6.8 and 10.7.5 is
     outlined below.
</p>
     <div class='center'>
<!-- l. 2977 --><p class='noindent'>
</p>
<div class='tabular'> <table class='tabular' id='TBL-2'><colgroup id='TBL-2-1g'><col id='TBL-2-1' /></colgroup><colgroup id='TBL-2-2g'><col id='TBL-2-2' /></colgroup><colgroup id='TBL-2-3g'><col id='TBL-2-3' /></colgroup><colgroup id='TBL-2-4g'><col id='TBL-2-4' /></colgroup><colgroup id='TBL-2-5g'><col id='TBL-2-5' /></colgroup><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-1-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-1-1' style='white-space:normal; text-align:left;'><!-- l. 2980 --><p class='noindent'><span class='ec-lmbx-10'>Model</span>         </p></td><td class='td11' id='TBL-2-1-2' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>10.6 (minimal)</span></td><td class='td11' id='TBL-2-1-3' style='white-space:nowrap; text-align:center;'> <span class='ec-lmbx-10'>10.6 (client) </span></td><td class='td11' id='TBL-2-1-4' style='white-space:nowrap; text-align:center;'> <span class='ec-lmbx-10'>10.6 (server) </span></td><td class='td11' id='TBL-2-1-5' style='white-space:nowrap; text-align:center;'>  <span class='ec-lmbx-10'>10.7 (any)   </span></td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-2-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-2-1' style='white-space:normal; text-align:left;'><!-- l. 2982 --><p class='noindent'>Macmini         </p></td><td class='td11' id='TBL-2-2-2' style='white-space:nowrap; text-align:center;'> 4,x (Mid 2010) </td><td class='td11' id='TBL-2-2-3' style='white-space:nowrap; text-align:center;'> 5,x (Mid 2011) </td><td class='td11' id='TBL-2-2-4' style='white-space:nowrap; text-align:center;'> 4,x (Mid 2010) </td><td class='td11' id='TBL-2-2-5' style='white-space:nowrap; text-align:center;'>3,x (Early 2009)</td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-3-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-3-1' style='white-space:normal; text-align:left;'><!-- l. 2984 --><p class='noindent'>MacBook        </p></td><td class='td11' id='TBL-2-3-2' style='white-space:nowrap; text-align:center;'>  Unsupported   </td><td class='td11' id='TBL-2-3-3' style='white-space:nowrap; text-align:center;'> Unsupported  </td><td class='td11' id='TBL-2-3-4' style='white-space:nowrap; text-align:center;'> Unsupported  </td><td class='td11' id='TBL-2-3-5' style='white-space:nowrap; text-align:center;'> 5,x (2009/09)  </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-4-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-4-1' style='white-space:normal; text-align:left;'><!-- l. 2986 --><p class='noindent'>MacBookAir    </p></td><td class='td11' id='TBL-2-4-2' style='white-space:nowrap; text-align:center;'>  Unsupported   </td><td class='td11' id='TBL-2-4-3' style='white-space:nowrap; text-align:center;'> Unsupported  </td><td class='td11' id='TBL-2-4-4' style='white-space:nowrap; text-align:center;'> Unsupported  </td><td class='td11' id='TBL-2-4-5' style='white-space:nowrap; text-align:center;'> 2,x (Late 2008) </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-5-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-5-1' style='white-space:normal; text-align:left;'><!-- l. 2988 --><p class='noindent'>MacBookPro   </p></td><td class='td11' id='TBL-2-5-2' style='white-space:nowrap; text-align:center;'>4,x (Early 2008)</td><td class='td11' id='TBL-2-5-3' style='white-space:nowrap; text-align:center;'>8,x (Early 2011)</td><td class='td11' id='TBL-2-5-4' style='white-space:nowrap; text-align:center;'>8,x (Early 2011)</td><td class='td11' id='TBL-2-5-5' style='white-space:nowrap; text-align:center;'> 3,x (Mid 2007) </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-6-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-6-1' style='white-space:normal; text-align:left;'><!-- l. 2990 --><p class='noindent'>iMac              </p></td><td class='td11' id='TBL-2-6-2' style='white-space:nowrap; text-align:center;'>8,x (Early 2008)</td><td class='td11' id='TBL-2-6-3' style='white-space:nowrap; text-align:center;'>12,x (Mid 2011)</td><td class='td11' id='TBL-2-6-4' style='white-space:nowrap; text-align:center;'>12,x (Mid 2011)</td><td class='td11' id='TBL-2-6-5' style='white-space:nowrap; text-align:center;'> 7,x (Mid 2007) </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-7-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-7-1' style='white-space:normal; text-align:left;'><!-- l. 2992 --><p class='noindent'>MacPro          </p></td><td class='td11' id='TBL-2-7-2' style='white-space:nowrap; text-align:center;'>3,x (Early 2008)</td><td class='td11' id='TBL-2-7-3' style='white-space:nowrap; text-align:center;'> 5,x (Mid 2010) </td><td class='td11' id='TBL-2-7-4' style='white-space:nowrap; text-align:center;'>3,x (Early 2008)</td><td class='td11' id='TBL-2-7-5' style='white-space:nowrap; text-align:center;'>3,x (Early 2008)</td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-2-8-' style='vertical-align:baseline;'><td class='td11' id='TBL-2-8-1' style='white-space:normal; text-align:left;'><!-- l. 2994 --><p class='noindent'>Xserve            </p></td><td class='td11' id='TBL-2-8-2' style='white-space:nowrap; text-align:center;'>2,x (Early 2008)</td><td class='td11' id='TBL-2-8-3' style='white-space:nowrap; text-align:center;'>2,x (Early 2008)</td><td class='td11' id='TBL-2-8-4' style='white-space:nowrap; text-align:center;'>2,x (Early 2008)</td><td class='td11' id='TBL-2-8-5' style='white-space:nowrap; text-align:center;'>2,x (Early 2008)</td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td></tr></table>                                                                                                  </div></div>
     <!-- l. 2999 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: <span class='ec-lmtt-10'>3+2 </span>and <span class='ec-lmtt-10'>6+4 </span>hotkeys to choose the preferred architecture are unsupported as they are handled by EfiBoot and
     hence, difficult to detect.
     </p></li>
<li class='enumerate' id='x1-40022x4'>
     <!-- l. 3003 --><p class='noindent'><span class='ec-lmtt-10'>KernelCache</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Prefer specified kernel cache type (<span class='ec-lmtt-10'>Auto</span>, <span class='ec-lmtt-10'>Cacheless</span>, <span class='ec-lmtt-10'>Mkext</span>, <span class='ec-lmtt-10'>Prelinked</span>) when available.
     </p><!-- l. 3009 --><p class='noindent'>Different variants of macOS support different kernel caching variants designed to improve boot performance. This
     setting prevents the use of faster kernel caching variants if slower variants are available for debugging
     and stability reasons. That is, by specifying <span class='ec-lmtt-10'>Mkext</span>, <span class='ec-lmtt-10'>Prelinked </span>will be disabled for e.g. 10.6 but not for
     10.7.
     </p><!-- l. 3014 --><p class='noindent'>The list of available kernel caching types and its current support in OpenCore is listed below.
</p>
     <div class='center'>
<!-- l. 3016 --><p class='noindent'>
</p>
<div class='tabular'> <table class='tabular' id='TBL-3'><colgroup id='TBL-3-1g'><col id='TBL-3-1' /></colgroup><colgroup id='TBL-3-2g'><col id='TBL-3-2' /></colgroup><colgroup id='TBL-3-3g'><col id='TBL-3-3' /></colgroup><colgroup id='TBL-3-4g'><col id='TBL-3-4' /></colgroup><colgroup id='TBL-3-5g'><col id='TBL-3-5' /></colgroup><colgroup id='TBL-3-6g'><col id='TBL-3-6' /></colgroup><colgroup id='TBL-3-7g'><col id='TBL-3-7' /></colgroup><colgroup id='TBL-3-8g'><col id='TBL-3-8' /></colgroup><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-1-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-1-1' style='white-space:normal; text-align:left;'><!-- l. 3019 --><p class='noindent'><span class='ec-lmbx-10'>macOS</span>   </p></td><td class='td11' id='TBL-3-1-2' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>i386 NC</span></td><td class='td11' id='TBL-3-1-3' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>i386 MK</span></td><td class='td11' id='TBL-3-1-4' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>i386 PK</span></td><td class='td11' id='TBL-3-1-5' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>x86_64 NC</span></td><td class='td11' id='TBL-3-1-6' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>x86_64 MK</span></td><td class='td11' id='TBL-3-1-7' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>x86_64 PK</span></td><td class='td11' id='TBL-3-1-8' style='white-space:nowrap; text-align:center;'><span class='ec-lmbx-10'>x86_64 KC</span></td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-2-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-2-1' style='white-space:normal; text-align:left;'><!-- l. 3021 --><p class='noindent'>10.4          </p></td><td class='td11' id='TBL-3-2-2' style='white-space:nowrap; text-align:center;'>  YES   </td><td class='td11' id='TBL-3-2-3' style='white-space:nowrap; text-align:center;'>YES (V1)</td><td class='td11' id='TBL-3-2-4' style='white-space:nowrap; text-align:center;'> NO (V1) </td><td class='td11' id='TBL-3-2-5' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-2-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-2-7' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-2-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-3-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-3-1' style='white-space:normal; text-align:left;'><!-- l. 3023 --><p class='noindent'>10.5          </p></td><td class='td11' id='TBL-3-3-2' style='white-space:nowrap; text-align:center;'>  YES   </td><td class='td11' id='TBL-3-3-3' style='white-space:nowrap; text-align:center;'>YES (V1)</td><td class='td11' id='TBL-3-3-4' style='white-space:nowrap; text-align:center;'> NO (V1) </td><td class='td11' id='TBL-3-3-5' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-3-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-3-7' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-3-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-4-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-4-1' style='white-space:normal; text-align:left;'><!-- l. 3025 --><p class='noindent'>10.6          </p></td><td class='td11' id='TBL-3-4-2' style='white-space:nowrap; text-align:center;'>  YES   </td><td class='td11' id='TBL-3-4-3' style='white-space:nowrap; text-align:center;'>YES (V2)</td><td class='td11' id='TBL-3-4-4' style='white-space:nowrap; text-align:center;'>YES (V2)</td><td class='td11' id='TBL-3-4-5' style='white-space:nowrap; text-align:center;'>    YES      </td><td class='td11' id='TBL-3-4-6' style='white-space:nowrap; text-align:center;'>  YES (V2)   </td><td class='td11' id='TBL-3-4-7' style='white-space:nowrap; text-align:center;'> YES (V2)  </td><td class='td11' id='TBL-3-4-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-5-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-5-1' style='white-space:normal; text-align:left;'><!-- l. 3027 --><p class='noindent'>10.7          </p></td><td class='td11' id='TBL-3-5-2' style='white-space:nowrap; text-align:center;'>  YES   </td><td class='td11' id='TBL-3-5-3' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-5-4' style='white-space:nowrap; text-align:center;'>YES (V3)</td><td class='td11' id='TBL-3-5-5' style='white-space:nowrap; text-align:center;'>    YES      </td><td class='td11' id='TBL-3-5-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-5-7' style='white-space:nowrap; text-align:center;'> YES (V3)  </td><td class='td11' id='TBL-3-5-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-6-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-6-1' style='white-space:normal; text-align:left;'><!-- l. 3029 --><p class='noindent'>10.8-10.9    </p></td><td class='td11' id='TBL-3-6-2' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-6-3' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-6-4' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-6-5' style='white-space:nowrap; text-align:center;'>    YES      </td><td class='td11' id='TBL-3-6-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-6-7' style='white-space:nowrap; text-align:center;'> YES (V3)  </td><td class='td11' id='TBL-3-6-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-7-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-7-1' style='white-space:normal; text-align:left;'><!-- l. 3031 --><p class='noindent'>10.10-10.15 </p></td><td class='td11' id='TBL-3-7-2' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-7-3' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-7-4' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-7-5' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-7-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-7-7' style='white-space:nowrap; text-align:center;'> YES (V3)  </td><td class='td11' id='TBL-3-7-8' style='white-space:nowrap; text-align:center;'>     —       </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr id='TBL-3-8-' style='vertical-align:baseline;'><td class='td11' id='TBL-3-8-1' style='white-space:normal; text-align:left;'><!-- l. 3033 --><p class='noindent'>11+          </p></td><td class='td11' id='TBL-3-8-2' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-8-3' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-8-4' style='white-space:nowrap; text-align:center;'>   —     </td><td class='td11' id='TBL-3-8-5' style='white-space:nowrap; text-align:center;'>     —       </td><td class='td11' id='TBL-3-8-6' style='white-space:nowrap; text-align:center;'>     —        </td><td class='td11' id='TBL-3-8-7' style='white-space:nowrap; text-align:center;'> YES (V3)  </td><td class='td11' id='TBL-3-8-8' style='white-space:nowrap; text-align:center;'>    YES      </td>
</tr><tr class='hline'><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr></table>                                                                                                  </div></div>
     <!-- l. 3038 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The first version (V1) of the 32-bit <span class='ec-lmtt-10'>prelinkedkernel </span>is unsupported due to the corruption of kext symbol tables
     by the tools. On this version, the <span class='ec-lmtt-10'>Auto </span>setting will block <span class='ec-lmtt-10'>prelinkedkernel </span>booting. This also results in the <span class='ec-lmtt-10'>keepsyms=1</span>
     boot argument being non-functional for kext frames on these systems.
</p>
     </li></ol>
<!-- l. 3046 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='misc'><span class='titlemark'>8   </span> <a id='x1-410008'></a>Misc</h3>
<!-- l. 3048 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction5'><span class='titlemark'>8.1   </span> <a id='x1-420008.1'></a>Introduction</h4>
<!-- l. 3050 --><p class='noindent'>This section contains miscellaneous configuration options affecting OpenCore operating system loading behaviour in addition
to other options that do not readily fit into other sections.
</p><!-- l. 3053 --><p class='noindent'>OpenCore broadly follows the “bless” model, also known as the “Apple Boot Policy”. The primary purpose of the “bless” model
is to allow embedding boot options within the file system (and be accessible through a specialised driver) as well as
supporting a broader range of predefined boot paths as compared to the removable media list set out in the UEFI
specification.
</p><!-- l. 3058 --><p class='noindent'>Partitions can only booted by OpenCore when they meet the requirements of a predefined <span class='ec-lmtt-10'>Scan policy</span>. This
policy sets out which specific file systems a partition must have, and which specific device types a partition
must be located on, to be made available by OpenCore as a boot option. Refer to the <span class='ec-lmtt-10'>ScanPolicy </span>property for
details.
</p><!-- l. 3063 --><p class='noindent'>The scan process starts with enumerating all available partitions, filtered based on the <span class='ec-lmtt-10'>Scan policy</span>. Each
partition may generate multiple primary and alternate options. Primary options represent operating systems
                                                                                                  
                                                                                                  
installed on the media, while alternate options represent recovery options for the operating systems on the media.
</p>
     <ul class='itemize1'>
     <li class='itemize'>Alternate options may exist without primary options and vice versa.
     </li>
     <li class='itemize'>Options may not necessarily represent operating systems on the same partition.
     </li>
     <li class='itemize'>
     <!-- l. 3070 --><p class='noindent'>Each primary and alternate option can be an auxiliary option or not. </p>
         <ul class='itemize2'>
         <li class='itemize'>Refer to the <span class='ec-lmtt-10'>HideAuxiliary </span>section for details.</li></ul>
     </li></ul>
<!-- l. 3077 --><p class='noindent'>The algorithm to determine boot options behaves as follows:
</p><!-- l. 3079 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-42002x1'>Obtain all available partition handles filtered based on the <span class='ec-lmtt-10'>Scan policy </span>(and driver availability).
     </li>
<li class='enumerate' id='x1-42004x2'>Obtain all available boot options from the <span class='ec-lmtt-10'>BootOrder </span>UEFI variable.
     </li>
<li class='enumerate' id='x1-42006x3'>
     <!-- l. 3083 --><p class='noindent'>For each boot option found: </p>
         <ul class='itemize1'>
         <li class='itemize'>Retrieve the device path of the boot option.
         </li>
         <li class='itemize'>Perform fixups (e.g. NVMe subtype correction) and expansion (e.g. for Boot Camp) of the device path.
         </li>
         <li class='itemize'>On failure, if it is an OpenCore custom entry device path, pre-construct the corresponding custom entry
         and succeed.
         </li>
         <li class='itemize'>Obtain the device handle by locating the device path of the resulting device path (ignore it on failure).
         </li>
         <li class='itemize'>Locate the device handle in the list of partition handles (ignore it if missing).
         </li>
         <li class='itemize'>For disk device paths (not specifying a bootloader), execute “bless” (may return &gt; 1 entry).
         </li>
         <li class='itemize'>For file device paths, check for presence on the file system directly.
         </li>
         <li class='itemize'>On the OpenCore boot partition, exclude all OpenCore bootstrap files by file header checks.
         </li>
                                                                                                  
                                                                                                  
         <li class='itemize'>Mark device handle as <span class='ec-lmri-10'>used </span>in the list of partition handles if any.
         </li>
         <li class='itemize'>Register the resulting entries as primary options and determine their types. <br class='newline' />The option will become auxiliary for some types (e.g. Apple HFS recovery).</li></ul>
     </li>
<li class='enumerate' id='x1-42008x4'>
     <!-- l. 3103 --><p class='noindent'>For each partition handle: </p>
         <ul class='itemize1'>
         <li class='itemize'>If the partition handle is marked as <span class='ec-lmri-10'>unused</span>, execute “bless” primary option list retrieval. <br class='newline' />In case a <span class='ec-lmtt-10'>BlessOverride </span>list is set, both standard and custom “bless” paths will be found.
         </li>
         <li class='itemize'>On the OpenCore boot partition, exclude OpenCore bootstrap files using header checks.
         </li>
         <li class='itemize'>Register the resulting entries as primary options and determine their types if found. <br class='newline' />The option will become auxiliary for some types (e.g. Apple HFS recovery).
         </li>
         <li class='itemize'>If a partition already has any primary options of the “Apple Recovery” type, proceed to the next handle.
         </li>
         <li class='itemize'>Lookup alternate entries by “bless” recovery option list retrieval and predefined paths.
         </li>
         <li class='itemize'>Register the resulting entries as alternate auxiliary options and determine their types if found.</li></ul>
     </li>
<li class='enumerate' id='x1-42010x5'>Custom entries and tools, except such pre-constructed previously, are added as primary options without any checks with
     respect to <span class='ec-lmtt-10'>Auxiliary</span>.
     </li>
<li class='enumerate' id='x1-42012x6'>System entries, such as <span class='ec-lmtt-10'>Reset NVRAM</span>, are added as primary auxiliary options.</li></ol>
<!-- l. 3119 --><p class='noindent'>The display order of the boot options in the OpenCore picker and the boot process are determined separately from the
scanning algorithm.
</p><!-- l. 3122 --><p class='noindent'>The display order as follows:
</p>
     <ul class='itemize1'>
     <li class='itemize'>Alternate options follow corresponding primary options. That is, Apple recovery options will follow the relevant
     macOS option whenever possible.
     </li>
     <li class='itemize'>Options will be listed in file system handle firmware order to maintain an established order across reboots
     regardless of the operating system chosen for loading.
     </li>
     <li class='itemize'>Custom entries, tools, and system entries will be added after all other options.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'>Auxiliary options will only be displayed upon entering “Extended Mode” in the OpenCore picker (typically by
     pressing the <span class='ec-lmtt-10'>Space </span>key).</li></ul>
<!-- l. 3135 --><p class='noindent'>The boot process is as follows: </p>
     <ul class='itemize1'>
     <li class='itemize'>Look up the first valid primary option in the <span class='ec-lmtt-10'>BootNext </span>UEFI variable.
     </li>
     <li class='itemize'>On failure, look up the first valid primary option in the <span class='ec-lmtt-10'>BootOrder </span>UEFI variable.
     </li>
     <li class='itemize'>Mark the option as the default option to boot.
     </li>
     <li class='itemize'>Boot option through the picker or without it depending on the <span class='ec-lmtt-10'>ShowPicker </span>option.
     </li>
     <li class='itemize'>Show picker on failure otherwise.</li></ul>
<!-- l. 3145 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This process will only work reliably when the <span class='ec-lmtt-10'>RequestBootVarRouting </span>option is enabled or the firmware does not
control UEFI boot options (<span class='ec-lmtt-10'>OpenDuetPkg </span>or custom BDS). When <span class='ec-lmtt-10'>LauncherOption </span>is not enabled, other operating systems
may overwrite OpenCore settings and this property should therefore be enabled when planning to use other operating
systems.
</p><!-- l. 3151 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: UEFI variable boot options boot arguments will be removed, if present, as they may contain arguments that can
compromise the operating system, which is undesirable when secure boot is enabled.
</p><!-- l. 3155 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: Some operating systems, such as Windows, may create a boot option and mark it as the topmost option upon first
boot or after NVRAM resets from within OpenCore. When this happens, the default boot entry choice will remain changed
until the next manual reconfiguration.
</p><!-- l. 3159 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties4'><span class='titlemark'>8.2   </span> <a id='x1-430008.2'></a>Properties</h4>
<!-- l. 3161 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-43002x1'><span class='ec-lmtt-10'>Boot</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply the boot configuration described in the <a href='#boot-properties'>Boot Properties</a> section below.
     </li>
<li class='enumerate' id='x1-43004x2'>
     <!-- l. 3169 --><p class='noindent'><span class='ec-lmtt-10'>BlessOverride</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Add custom scanning paths through the bless model.
     </p><!-- l. 3174 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist string </span>entries containing absolute UEFI paths to customised bootloaders such as
     <span class='ec-lmtt-10'>\EFI\debian\grubx64.efi </span>for the Debian bootloader. This allows non-standard boot paths to be automatically
     discovered  by  the  OpenCore  picker.  Designwise,  they  are  equivalent  to  predefined  blessed  paths,  such  as
                                                                                                  
                                                                                                  
     <span class='ec-lmtt-10'>\System\Library\CoreServices\boot.efi </span>or  <span class='ec-lmtt-10'>\EFI\Microsoft\Boot\bootmgfw.efi</span>,  but  unlike  predefined
     bless paths, they have the highest priority.
     </p></li>
<li class='enumerate' id='x1-43006x3'><span class='ec-lmtt-10'>Debug</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply debug configuration described in the <a href='#debug-properties'>Debug Properties</a> section below.
     </li>
<li class='enumerate' id='x1-43008x4'>
     <!-- l. 3190 --><p class='noindent'><span class='ec-lmtt-10'>Entries</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Add boot entries to OpenCore picker.
     </p><!-- l. 3195 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each load entry. Refer to the <a href='#entry-properties'>Entry Properties</a> section below for
     details.
     </p></li>
<li class='enumerate' id='x1-43010x5'><span class='ec-lmtt-10'>Security</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply the security configuration described in the <a href='#security-properties'>Security Properties</a> section below.
     </li>
<li class='enumerate' id='x1-43012x6'>
     <!-- l. 3205 --><p class='noindent'><span class='ec-lmtt-10'>Serial</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform serial port initialisation and configure PCD values required by <span class='ec-lmtt-10'>BaseSerialPortLib16550</span>
     for serial ports to properly function. Values are listed and described in the <a href='#serial-properties'>Serial Properties</a> and <a href='#serial-custom-properties'>Serial Custom
     Properties</a> section below.
     </p><!-- l. 3211 --><p class='noindent'>By enabling <span class='ec-lmtt-10'>Init</span>, this section ensures that the serial port is initialised when it is not done by firmware. In order
     for OpenCore to print logs to the serial port, bit <span class='ec-lmtt-10'>3 </span>(i.e. serial logging) for <span class='ec-lmtt-10'>Target </span>under section <span class='ec-lmtt-10'>Misc-&gt;Debug</span>
     must be set.
     </p><!-- l. 3215 --><p class='noindent'>When debugging with serial ports, <span class='ec-lmtt-10'>BaseSerialPortLib16550 </span>only recognises internal ones provided by the
     motherboard by default. If the option <span class='ec-lmtt-10'>Override </span>is enabled, this section will override the PCD values listed in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.inf'>BaseSerialPortLib16550.inf</a> such that external serial ports (e.g. from a PCI card) will also function properly.
     Specifically, when troubleshooting macOS, in addition to overriding these PCD values, it is also necessary to
     turn the <span class='ec-lmtt-10'>CustomPciSerialDevice </span>kernel quirk on in order for the XNU to use such exterior serial ports.
     </p><!-- l. 3223 --><p class='noindent'>Refer to <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a> for the explanations of each key.
     </p></li>
<li class='enumerate' id='x1-43014x7'>
     <!-- l. 3226 --><p class='noindent'><span class='ec-lmtt-10'>Tools</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Add tool entries to the OpenCore picker.
     </p><!-- l. 3231 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each load entry. Refer to the <a href='#entry-properties'>Entry Properties</a> section below for
     details.
                                                                                                  
                                                                                                  
     </p><!-- l. 3234 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Certain UEFI tools, such as UEFI Shell, can be very dangerous and <span class='ec-lmbx-10'>MUST NOT </span>appear in production
     configurations, paticularly in vaulted configurations as well as those protected by secure boot, as such tools can
     be used to bypass the secure boot chain. Refer to the <a href='#tools-and-applications'>UEFI</a> section for examples of UEFI tools.
</p>
     </li></ol>
<!-- l. 3242 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='boot-properties'><span class='titlemark'>8.3   </span> <a id='x1-440008.3'></a>Boot Properties</h4>
<!-- l. 3244 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-44002x1'>
     <!-- l. 3247 --><p class='noindent'><span class='ec-lmtt-10'>ConsoleAttributes</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets specific attributes for the console.
     </p><!-- l. 3252 --><p class='noindent'>The text renderer supports colour arguments as a sum of foreground and background colours based on the UEFI
     specification. The value for black background and for black foreground, <span class='ec-lmtt-10'>0</span>, is reserved.
     </p><!-- l. 3256 --><p class='noindent'>List of colour values and names:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00 </span>— <span class='ec-lmtt-10'>EFI_BLACK</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— <span class='ec-lmtt-10'>EFI_BLUE</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>— <span class='ec-lmtt-10'>EFI_GREEN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x03 </span>— <span class='ec-lmtt-10'>EFI_CYAN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>— <span class='ec-lmtt-10'>EFI_RED</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x05 </span>— <span class='ec-lmtt-10'>EFI_MAGENTA</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x06 </span>— <span class='ec-lmtt-10'>EFI_BROWN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x07 </span>— <span class='ec-lmtt-10'>EFI_LIGHTGRAY</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x08 </span>— <span class='ec-lmtt-10'>EFI_DARKGRAY</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x09 </span>— <span class='ec-lmtt-10'>EFI_LIGHTBLUE</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0A </span>— <span class='ec-lmtt-10'>EFI_LIGHTGREEN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0B </span>— <span class='ec-lmtt-10'>EFI_LIGHTCYAN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0C </span>— <span class='ec-lmtt-10'>EFI_LIGHTRED</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0D </span>— <span class='ec-lmtt-10'>EFI_LIGHTMAGENTA</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0E </span>— <span class='ec-lmtt-10'>EFI_YELLOW</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0F </span>— <span class='ec-lmtt-10'>EFI_WHITE</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_BLACK</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x10 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_BLUE</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x20 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_GREEN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x30 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_CYAN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x40 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_RED</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x50 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_MAGENTA</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x60 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_BROWN</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x70 </span>— <span class='ec-lmtt-10'>EFI_BACKGROUND_LIGHTGRAY</span></li></ul>
     <!-- l. 3286 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option may not work well with the <span class='ec-lmtt-10'>System </span>text renderer. Setting a background different from black could help
     with testing GOP functionality.
     </p></li>
<li class='enumerate' id='x1-44004x2'>
     <!-- l. 3290 --><p class='noindent'><span class='ec-lmtt-10'>HibernateMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>None</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Hibernation detection mode. The following modes are supported:
</p>
         <ul class='itemize1'>
                                                                                                  
                                                                                                  
         <li class='itemize'><span class='ec-lmtt-10'>None </span>— Ignore hibernation state.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Auto </span>— Use RTC and NVRAM detection.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>RTC </span>— Use RTC detection.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>NVRAM </span>— Use NVRAM detection.</li></ul>
     <!-- l. 3303 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: If the firmware can handle hibernation itself (valid for Mac EFI firmware), then <span class='ec-lmtt-10'>None </span>should be specified to
     hand-off hibernation state as is to OpenCore.
     </p></li>
<li class='enumerate' id='x1-44006x3'>
     <!-- l. 3307 --><p class='noindent'><span class='ec-lmtt-10'>HideAuxiliary</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to hide auxiliary entries from the picker menu.
     </p><!-- l. 3312 --><p class='noindent'>An entry is considered auxiliary when at least one of the following applies:
</p>
         <ul class='itemize1'>
         <li class='itemize'>Entry is macOS recovery.
         </li>
         <li class='itemize'>Entry is macOS Time Machine.
         </li>
         <li class='itemize'>Entry is explicitly marked as <span class='ec-lmtt-10'>Auxiliary</span>.
         </li>
         <li class='itemize'>Entry is system (e.g. <span class='ec-lmtt-10'>Reset NVRAM</span>).</li></ul>
     <!-- l. 3322 --><p class='noindent'>To display all entries, the picker menu can be reloaded into “Extended Mode” by pressing the <span class='ec-lmtt-10'>Spacebar </span>key. Hiding
     auxiliary entries may increase boot performance on multi-disk systems.
     </p></li>
<li class='enumerate' id='x1-44008x4'>
     <!-- l. 3326 --><p class='noindent'><span class='ec-lmtt-10'>LauncherOption</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Disabled</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Register the launcher option in the firmware preferences for persistence.
     </p><!-- l. 3331 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Disabled </span>— do nothing.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'>
         <!-- l. 3336 --><p class='noindent'><span class='ec-lmtt-10'>Full </span>— create or update the top priority boot option in UEFI variable storage at bootloader startup.
         </p>
             <ul class='itemize2'>
             <li class='itemize'>For this option to work, <span class='ec-lmtt-10'>RequestBootVarRouting </span>is required to be enabled.</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 3342 --><p class='noindent'><span class='ec-lmtt-10'>Short </span>— create a short boot option instead of a complete one. </p>
             <ul class='itemize2'>
             <li class='itemize'>This variant is useful for some older types of firmware, typically from Insyde, that are unable to manage
             full device paths.</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 3348 --><p class='noindent'><span class='ec-lmtt-10'>System </span>— create no boot option but assume specified custom option is blessed. </p>
             <ul class='itemize2'>
             <li class='itemize'>This variant is useful when relying on <span class='ec-lmtt-10'>ForceBooterSignature </span>quirk and OpenCore launcher path
             management happens through <span class='ec-lmtt-10'>bless </span>utilities without involving OpenCore.</li></ul>
         </li></ul>
     <!-- l. 3357 --><p class='noindent'>This option allows integration with third-party operating system installation and upgrades (which may overwrite the
     <span class='ec-lmtt-10'>\EFI\BOOT\BOOTx64.efi </span>file). The BOOTx64.efi file is no longer used for bootstrapping OpenCore if a custom
     option is created. The custom path used for bootstrapping can be specified by using the <span class='ec-lmtt-10'>LauncherPath</span>
     option.
     </p><!-- l. 3362 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Some types of firmware may have NVRAM implementation flaws, no boot option support, or other
     incompatibilities. While unlikely, the use of this option may result in boot failures and should only be used exclusively on
     boards known to be compatible. Refer to <a href='https://github.com/acidanthera/bugtracker/issues/1222'>acidanthera/bugtracker#1222</a> for some known issues affecting Haswell and
     other boards.
     </p><!-- l. 3368 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: While NVRAM resets executed from OpenCore would not typically erase the boot option created in <span class='ec-lmtt-10'>Bootstrap</span>,
     executing NVRAM resets prior to loading OpenCore will erase the boot option. Therefore, for significant implementation
     updates, such as was the case with OpenCore 0.6.4, an NVRAM reset should be executed with <span class='ec-lmtt-10'>Bootstrap </span>disabled, after
     which it can be re-enabled.
     </p><!-- l. 3373 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: Some versions of Intel Visual BIOS (e.g. on Intel NUC) have an unfortunate bug whereby if any boot option is
     added referring to a path on a USB drive, from then on that is the only boot option which will be shown when any USB
     drive is inserted. If OpenCore is started from a USB drive on this firmware with <span class='ec-lmtt-10'>LauncherOption </span>set to <span class='ec-lmtt-10'>Full </span>or
     <span class='ec-lmtt-10'>Short</span>, this applies and only the OpenCore boot entry will be seen afterwards, when any other USB is
     inserted (this highly non-standard BIOS behaviour affects other software as well). The best way to avoid
     this is to leave <span class='ec-lmtt-10'>LauncherOption </span>set to <span class='ec-lmtt-10'>Disabled </span>or <span class='ec-lmtt-10'>System </span>on any version of OpenCore which will be
     started from a USB drive on this firmware. If the problem has already occurred the quickest reliable fix is:
     </p>
         <ul class='itemize1'>
         <li class='itemize'>Enable the system UEFI Shell in Intel Visual BIOS
         </li>
         <li class='itemize'>With power off, insert an OpenCore USB
         </li>
         <li class='itemize'>Power up and select the system UEFI Shell
         </li>
         <li class='itemize'>Since the system shell does not include <span class='ec-lmtt-10'>bcfg</span>, use the system shell to start OpenCore’s OpenShell (e.g. by
         entering the command <span class='ec-lmtt-10'>FS2:\EFI\OC\Tools\OpenShell.efi </span>, but you will need to work out which drive is
                                                                                                  
                                                                                                  
         correct for OpenCore and modify the drive number <span class='ec-lmtt-10'>FS#: </span>accordingly)
         </li>
         <li class='itemize'>Within OpenShell, use <span class='ec-lmtt-10'>bcfg boot dump </span>to display the NVRAM boot options and then use <span class='ec-lmtt-10'>bcfg boot rm
         </span><span class='ec-lmtt-10'># </span>(where <span class='ec-lmtt-10'># </span>is the number of the OpenCore boot entry) to remove the OpenCore entry</li></ul>
     <!-- l. 3392 --><p class='noindent'>It is alternatively possible to start OpenShell directly from the OpenCore boot menu, if you have a working configured
     OpenCore for the system. In that case, and if OpenCore has <span class='ec-lmtt-10'>RequestBootVarRouting </span>enabled, it will be necessary to run
     the command <span class='ec-lmtt-10'>\EFI\OC\Tools\OpenControl.efi disable </span>before using <span class='ec-lmtt-10'>bcfg</span>. (After <span class='ec-lmtt-10'>OpenControl disable</span>, it is
     necessary to either reboot or run <span class='ec-lmtt-10'>OpenControl restore</span>, before booting an operating system.) It is also possible to use
     <span class='ec-lmtt-10'>efibootmgr </span>within Linux to remove the offending entry, if you have a working version of Linux on the machine. Linux
     must be started either not via OpenCore, or via OpenCore with <span class='ec-lmtt-10'>RequestBootVarRouting </span>disabled for this to
     work.
     </p></li>
<li class='enumerate' id='x1-44010x5'>
     <!-- l. 3402 --><p class='noindent'><span class='ec-lmtt-10'>LauncherPath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Default</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Launch path for the <span class='ec-lmtt-10'>LauncherOption </span>property.
     </p><!-- l. 3407 --><p class='noindent'><span class='ec-lmtt-10'>Default </span>points to <span class='ec-lmtt-10'>OpenCore.efi</span>. User specified paths, e.g. <span class='ec-lmtt-10'>\EFI\SomeLauncher.efi</span>, can be used to provide custom
     loaders, which are supposed to load <span class='ec-lmtt-10'>OpenCore.efi </span>themselves.
     </p></li>
<li class='enumerate' id='x1-44012x6'>
     <!-- l. 3413 --><p class='noindent'><span class='ec-lmtt-10'>PickerAttributes</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets specific attributes for the OpenCore picker.
     </p><!-- l. 3418 --><p class='noindent'>Different OpenCore pickers may be configured through the attribute mask containing OpenCore-reserved (<span class='ec-lmtt-10'>BIT0</span>~<span class='ec-lmtt-10'>BIT15</span>)
     and OEM-specific (<span class='ec-lmtt-10'>BIT16</span>~<span class='ec-lmtt-10'>BIT31</span>) values.
     </p><!-- l. 3422 --><p class='noindent'>Current OpenCore values include:
</p>
         <ul class='itemize1'>
         <li class='itemize'>
         <!-- l. 3426 --><p class='noindent'><span class='ec-lmtt-10'>0x0001 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_VOLUME_ICON</span>, provides custom icons for boot entries:
         </p><!-- l. 3429 --><p class='noindent'>OpenCore will attempt loading a volume icon by searching as follows, and will fallback to the default icon on failure:
         </p>
             <ul class='itemize2'>
             <li class='itemize'><span class='ec-lmtt-10'>.VolumeIcon.icns       </span>file           at           <span class='ec-lmtt-10'>Preboot       </span>volume           in           per-volume
             directory (<span class='ec-lmtt-10'>/System/Volumes/Preboot/{GUID}/ </span>when mounted at the default location within macOS)
             for APFS (if present).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>.VolumeIcon.icns </span>file at the <span class='ec-lmtt-10'>Preboot </span>volume root (<span class='ec-lmtt-10'>/System/Volumes/Preboot/</span>, when mounted at
             the default location within macOS) for APFS (otherwise).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>.VolumeIcon.icns </span>file at the volume root for other filesystems.</li></ul>
         <!-- l. 3442 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: The Apple picker partially supports placing a volume icon file at the operating system’s <span class='ec-lmtt-10'>Data </span>volume root,
         <span class='ec-lmtt-10'>/System/Volumes/Data/</span>, when mounted at the default location within macOS. This approach is flawed: the file is
                                                                                                  
                                                                                                  
         neither accessible to OpenCanopy nor to the Apple picker when FileVault 2, which is meant to be the default choice,
         is enabled. Therefore, OpenCanopy does not attempt supporting Apple’s approach. A volume icon file may be
         placed at the root of the <span class='ec-lmtt-10'>Preboot </span>volume for compatibility with both OpenCanopy and the Apple picker, or use the
         <span class='ec-lmtt-10'>Preboot </span>per-volume location as above with OpenCanopy as a preferred alternative to Apple’s approach.
         </p><!-- l. 3451 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Be aware that using a volume icon on any drive overrides the normal OpenCore picker behaviour for
         that drive of selecting the appropriate icon depending on whether the drive is internal or external.
         </p></li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0002 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_DISK_LABEL_FILE</span>, use custom prerendered titles for boot entries from <span class='ec-lmtt-10'>.disk_label</span>
         (<span class='ec-lmtt-10'>.disk_label_2x</span>) file next to the bootloader for all filesystems. These labels can be generated via the <span class='ec-lmtt-10'>disklabel</span>
         utility or the <span class='ec-lmtt-10'>bless --folder {FOLDER_PATH} --label {LABEL_TEXT} </span>command. When prerendered labels are
         disabled or missing, use label text in <span class='ec-lmtt-10'>.contentDetails </span>(or <span class='ec-lmtt-10'>.disk_label.contentDetails</span>) file next to bootloader if
         present instead, otherwise the entry name itself will be rendered.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0004 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_GENERIC_LABEL_IMAGE</span>, provides predefined label images for boot entries without custom
         entries. This may however give less detail for the actual boot entry.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0008 </span>— <span class='ec-lmtt-10'>OC_ATTR_HIDE_THEMED_ICONS</span>, prefers builtin icons for certain icon categories to match
         the theme style. For example, this could force displaying the builtin Time Machine icon. Requires
         <span class='ec-lmtt-10'>OC_ATTR_USE_VOLUME_ICON</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0010 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_POINTER_CONTROL</span>, enables pointer control in the OpenCore picker when available. For
         example, this could make use of mouse or trackpad to control UI elements.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0020 </span>— <span class='ec-lmtt-10'>OC_ATTR_SHOW_DEBUG_DISPLAY</span>, enable display of additional timing and debug information, in Builtin
         picker in <span class='ec-lmtt-10'>DEBUG </span>and <span class='ec-lmtt-10'>NOOPT </span>builds only.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0040 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_MINIMAL_UI</span>, use minimal UI display, no Shutdown or Restart buttons, affects OpenCanopy
         and builtin picker.
         </li>
         <li class='itemize'>
         <!-- l. 3477 --><p class='noindent'><span class='ec-lmtt-10'>0x0080 </span>— <span class='ec-lmtt-10'>OC_ATTR_USE_FLAVOUR_ICON</span>, provides flexible boot entry content description, suitable for picking the
         best media across different content sets:
         </p><!-- l. 3481 --><p class='noindent'>When enabled, the entry icon in OpenCanopy and the audio assist entry sound in OpenCanopy and builtin boot
         picker are chosen by something called content flavour. To determine content flavour the following algorithm is
         used:
</p>
             <ul class='itemize2'>
             <li class='itemize'>For a Tool the value is read from <span class='ec-lmtt-10'>Flavour </span>field.
             </li>
             <li class='itemize'>For an automatically discovered entry, including for boot entry protocol entries such as those generated
             by the OpenLinuxBoot driver, it is read from the <span class='ec-lmtt-10'>.contentFlavour </span>file next to the bootloader, if
             present.
             </li>
             <li class='itemize'>For a custom entry specified in the <span class='ec-lmtt-10'>Entries </span>section it is read from the <span class='ec-lmtt-10'>.contentFlavour </span>file next to
             the bootloader if <span class='ec-lmtt-10'>Flavour </span>is <span class='ec-lmtt-10'>Auto</span>, otherwise it is specified via the <span class='ec-lmtt-10'>Flavour </span>value itself.
                                                                                                  
                                                                                                  
             </li>
             <li class='itemize'>If read flavour is <span class='ec-lmtt-10'>Auto </span>or there is no <span class='ec-lmtt-10'>.contentFlavour</span>, entry flavour is chosen based on the entry type
             (e.g. Windows automatically gets Windows flavour).</li></ul>
         <!-- l. 3499 --><p class='noindent'>The Flavour value is a sequence of <span class='ec-lmtt-10'>: </span>separated names limited to 64 characters of printable 7-bit ASCII. This is
         designed to support up to approximately five names. Each name refers to a flavour, with the first name having the
         highest priority and the last name having the lowest priority. Such a structure allows describing an entry in a more
         specific way, with icons selected flexibly depending on support by the audio-visual pack. A missing audio or icon file
         means the next flavour should be tried, and if all are missing the choice happens based on the type of the
         entry. Example flavour values: <span class='ec-lmtt-10'>BigSur:Apple</span>, <span class='ec-lmtt-10'>Windows10:Windows</span>. <span class='ec-lmtt-10'>OpenShell:UEFIShell:Shell</span>.
         </p><!-- l. 3509 --><p class='noindent'>Using flavours means that you can switch between icon sets easily, with the flavour selecting the best available icons
         from each set. E.g. specifying icon flavour <span class='ec-lmtt-10'>Debian:Linux </span>will use the icon <span class='ec-lmtt-10'>Debian.icns </span>if provided,
         then will try <span class='ec-lmtt-10'>Linux.icns</span>, then will fall back to the default for an OS, which is <span class='ec-lmtt-10'>HardDrive.icns</span>.
         </p><!-- l. 3515 --><p class='noindent'>Things to keep in mind:
</p>
             <ul class='itemize2'>
             <li class='itemize'>For  security  reasons  <span class='ec-lmtt-10'>Ext&lt;Flavour&gt;.icns </span>and  <span class='ec-lmtt-10'>&lt;Flavour&gt;.icns </span>are  both  supported,  and  only
             <span class='ec-lmtt-10'>Ext&lt;Flavour&gt;.icns </span>will be used if the entry is on an external drive (followed by default fallback
             <span class='ec-lmtt-10'>ExtHardDrive.icns</span>).
             </li>
             <li class='itemize'>Where both apply <span class='ec-lmtt-10'>.VolumeIcon.icns </span>takes precence over <span class='ec-lmtt-10'>.contentFlavour</span>.
             </li>
             <li class='itemize'>In order to allow icons and audio assist to work correctly for tools (e.g.  for UEFI Shell), system
             default boot entry icons (see <span class='ec-lmtt-10'>Docs/Flavours.md</span>) specified in the <span class='ec-lmtt-10'>Flavour </span>setting for <span class='ec-lmtt-10'>Tools </span>or <span class='ec-lmtt-10'>Entries</span>
             will continue to apply even when flavour is disabled. Non-system icons will be ignored in this case.
             In addition, the flavours <span class='ec-lmtt-10'>UEFIShell </span>and <span class='ec-lmtt-10'>NVRAMReset </span>are given special processing, identifying their
             respective tools to apply correct audio-assist, default builtin labels, etc.
             </li>
             <li class='itemize'>A list of recommended flavours is provided in <span class='ec-lmtt-10'>Docs/Flavours.md</span>.</li></ul>
         </li></ul>
     </li>
<li class='enumerate' id='x1-44014x7'>
     <!-- l. 3535 --><p class='noindent'><span class='ec-lmtt-10'>PickerAudioAssist</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable screen reader by default in the OpenCore picker.
     </p><!-- l. 3540 --><p class='noindent'>For the macOS bootloader, screen reader preference is set in the <span class='ec-lmtt-10'>preferences.efires </span>archive in the
     <span class='ec-lmtt-10'>isVOEnabled.int32 </span>file and is controlled by the operating system. For OpenCore screen reader support,
     this option is an independent equivalent. Toggling screen reader support in both the OpenCore picker
     and the macOS bootloader FileVault 2 login window can also be done by using the <span class='ec-lmtt-10'>Command </span>+ <span class='ec-lmtt-10'>F5 </span>key
     combination.
     </p><!-- l. 3547 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The screen reader requires working audio support. Refer to the <a href='#audio-properties'><span class='ec-lmtt-10'>UEFI Audio Properties</span></a> section for
     details.
     </p></li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-44016x8'>
     <!-- l. 3551 --><p class='noindent'><span class='ec-lmtt-10'>PollAppleHotKeys</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable <span class='ec-lmtt-10'>modifier hotkey </span>handling in the OpenCore picker.
     </p><!-- l. 3556 --><p class='noindent'>In addition to <span class='ec-lmtt-10'>action hotkeys</span>, which are partially described in the <span class='ec-lmtt-10'>PickerMode </span>section and are typically handled by
     Apple BDS, modifier keys handled by the operating system bootloader (<span class='ec-lmtt-10'>boot.efi</span>) also exist. These keys allow changing
     the behaviour of the operating system by providing different boot modes.
     </p><!-- l. 3561 --><p class='noindent'>On certain firmware, using modifier keys may be problematic due to driver incompatibilities. To workaround this
     problem, this option allows registering certain hotkeys in a more permissive manner from within the OpenCore
     picker. Such extensions include support for tapping on key combinations before selecting the boot item,
     and for reliable detection of the <span class='ec-lmtt-10'>Shift </span>key when selecting the boot item, in order to work around the
     fact that hotkeys which are continuously held during boot cannot be reliably detected on many PS/2
     keyboards.
     </p><!-- l. 3568 --><p class='noindent'>This list of known <span class='ec-lmtt-10'>modifier hotkeys </span>includes: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>CMD+C+MINUS </span>— disable board compatibility checking.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>CMD+K </span>— boot release kernel, similar to <span class='ec-lmtt-10'>kcsuffix=release</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>CMD+S </span>— single user mode.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>CMD+S+MINUS </span>— disable KASLR slide, requires disabled SIP.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>CMD+V </span>— verbose mode.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Shift+Enter</span>, <span class='ec-lmtt-10'>Shift+Index </span>— safe mode, may be used in combination with <span class='ec-lmtt-10'>CTRL+Enter</span>, <span class='ec-lmtt-10'>CTRL+Index</span>.</li></ul>
     </li>
<li class='enumerate' id='x1-44018x9'><span class='ec-lmtt-10'>ShowPicker</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Show a simple picker to allow boot entry selection.
     </li>
<li class='enumerate' id='x1-44020x10'>
     <!-- l. 3587 --><p class='noindent'><span class='ec-lmtt-10'>TakeoffDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Delay in microseconds executed before handling the OpenCore picker startup and <span class='ec-lmtt-10'>action
     </span><span class='ec-lmtt-10'>hotkeys</span>.
     </p><!-- l. 3593 --><p class='noindent'>Introducing a delay may give extra time to hold the right <span class='ec-lmtt-10'>action hotkey </span>sequence to, for instance, boot into recovery
     mode. On most systems, the appearance of the initial boot logo is a good indication of the time from which hotkeys can
     be held down. Earlier than this, the key press may not be registered. On some platforms, setting this option to a
     minimum of <span class='ec-lmtt-10'>5000-10000 </span>microseconds is also required to access <span class='ec-lmtt-10'>action hotkeys </span>due to the nature of the keyboard
                                                                                                  
                                                                                                  
     driver.
     </p><!-- l. 3600 --><p class='noindent'>If the boot chime is configured (see audio configuration options) then at the expense of slower startup, an even longer
     delay of half to one second (<span class='ec-lmtt-10'>500000-1000000</span>) may be used to create behaviour similar to a real Mac, where the chime
     itself can be used as a signal for when hotkeys can be pressed. The boot chime is inevitably later in the boot sequence in
     OpenCore than on Apple hardware, due to the fact that non-native drivers have to be loaded and connected first.
     Configuring the boot chime and adding this longer additional delay can also be useful in systems where fast boot time
     and/or slow monitor signal synchronisation may cause the boot logo not to be shown at all on some boots or
     reboots.
     </p></li>
<li class='enumerate' id='x1-44022x11'><span class='ec-lmtt-10'>Timeout</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Timeout in seconds in the OpenCore picker before automatic booting of the default boot entry. Set to <span class='ec-lmtt-10'>0 </span>to
     disable.
     </li>
<li class='enumerate' id='x1-44024x12'>
     <!-- l. 3617 --><p class='noindent'><span class='ec-lmtt-10'>PickerMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Builtin</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Choose picker used for boot management.
     </p><!-- l. 3622 --><p class='noindent'><span class='ec-lmtt-10'>PickerMode </span>describes the underlying boot management with an optional user interface responsible for handling boot
     options.
     </p><!-- l. 3625 --><p class='noindent'>The following values are supported:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Builtin </span>— boot management is handled by OpenCore, a simple text-only user interface is used.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>External </span>— an external boot management protocol is used if available. Otherwise, the <span class='ec-lmtt-10'>Builtin </span>mode is
         used.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Apple </span>— Apple boot management is used if available. Otherwise, the <span class='ec-lmtt-10'>Builtin </span>mode is used.</li></ul>
     <!-- l. 3637 --><p class='noindent'>Upon success, the <span class='ec-lmtt-10'>External </span>mode may entirely disable all boot management in OpenCore except for policy enforcement.
     In the <span class='ec-lmtt-10'>Apple </span>mode, it may additionally bypass policy enforcement. Refer to the <a href='#opencanopy'>OpenCanopy</a> plugin for an example of a
     custom user interface.
     </p><!-- l. 3642 --><p class='noindent'>The OpenCore built-in picker contains a set of actions chosen during the boot process. The list of supported
     actions is similar to Apple BDS and typically can be accessed by holding <span class='ec-lmtt-10'>action hotkeys </span>during the boot
     process.
     </p><!-- l. 3646 --><p class='noindent'>The following actions are currently considered:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Default </span>— this is the default option, and it lets the built-in OpenCore picker load the default boot option
                                                                                                  
                                                                                                  
         as specified in the <a href='https://support.apple.com/HT202796'>Startup Disk</a> preference pane.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ShowPicker </span>— this option forces the OpenCore picker to be displayed. This can typically be achieved by
         holding the <span class='ec-lmtt-10'>OPT </span>key during boot. Setting <span class='ec-lmtt-10'>ShowPicker </span>to <span class='ec-lmtt-10'>true </span>will make <span class='ec-lmtt-10'>ShowPicker </span>the default option.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BootApple </span>— this options performs booting to the first Apple operating system found unless the chosen
         default operating system is one from Apple. Hold the <span class='ec-lmtt-10'>X </span>key down to choose this option.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BootAppleRecovery </span>— this option performs booting into the Apple operating system recovery partition.
         This is either that related to the default chosen operating system, or first one found when the chosen
         default operating system is not from Apple or does not have a recovery partition. Hold the <span class='ec-lmtt-10'>CMD+R </span>hotkey
         combination down to choose this option.</li></ul>
     <!-- l. 3665 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: On non-Apple firmware <span class='ec-lmtt-10'>KeySupport</span>, <span class='ec-lmtt-10'>OpenUsbKbDxe</span>, or similar drivers are required for key handling. However,
     not all of the key handling functions can be implemented on several types of firmware.
     </p><!-- l. 3669 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: In addition to <span class='ec-lmtt-10'>OPT</span>, OpenCore supports using both the <span class='ec-lmtt-10'>Escape </span>and <span class='ec-lmtt-10'>Zero </span>keys to enter the OpenCore picker when
     <span class='ec-lmtt-10'>ShowPicker </span>is disabled. <span class='ec-lmtt-10'>Escape </span>exists to support co-existence with the Apple picker (including OpenCore <span class='ec-lmtt-10'>Apple </span>picker
     mode) and to support firmware that fails to report held <span class='ec-lmtt-10'>OPT </span>key, as on some PS/2 keyboards. In addition, <span class='ec-lmtt-10'>Zero </span>is
     provided to support systems on which <span class='ec-lmtt-10'>Escape </span>is already assigned to some other pre-boot firmware feature. In
     systems which do not require <span class='ec-lmtt-10'>KeySupport</span>, pressing and holding one of these keys from after power on until
     the picker appears should always be successful. The same should apply when using <span class='ec-lmtt-10'>KeySupport </span>mode if
     it is correctly configured for the system, i.e. with a long enough <span class='ec-lmtt-10'>KeyForgetThreshold</span>. If pressing and
     holding the key is not successful to reliably enter the picker, multiple repeated keypresses may be tried
     instead.
     </p><!-- l. 3680 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: On Macs with problematic GOP, it may be difficult to access the Apple picker. The <span class='ec-lmtt-10'>BootKicker </span>utility can be
     blessed to workaround this problem even without loading OpenCore. On some Macs however, the <span class='ec-lmtt-10'>BootKicker </span>utility
     cannot be run from OpenCore.
     </p></li>
<li class='enumerate' id='x1-44026x13'>
     <!-- l. 3685 --><p class='noindent'><span class='ec-lmtt-10'>PickerVariant</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Choose specific icon set to be used for boot management.
     </p><!-- l. 3690 --><p class='noindent'>An icon set is a directory path relative to <span class='ec-lmtt-10'>Resources\Image</span>, where the icons and an optional manifest
     are located. It is recommended for the artists to use provide their sets in the <span class='ec-lmtt-10'>Vendor\Set </span>format, e.g.
     <span class='ec-lmtt-10'>Acidanthera\GoldenGate</span>.
     </p><!-- l. 3695 --><p class='noindent'>Sample resources provided as a part of <a href='https://github.com/acidanthera/OcBinaryData'>OcBinaryData repository</a> provide the following icon set: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Acidanthera\GoldenGate </span>— macOS 11 styled icon set.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Acidanthera\Syrah </span>— macOS 10.10 styled icon set.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Acidanthera\Chardonnay </span>— macOS 10.4 styled icon set.</li></ul>
     <!-- l. 3705 --><p class='noindent'>For convenience purposes there also are predefined aliases: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Auto  </span>—   Automatically   select   one   set   of   icons   based   on   the   <span class='ec-lmtt-10'>DefaultBackground  </span>colour:
         <span class='ec-lmtt-10'>Acidanthera\GoldenGate </span>for Syrah Black and <span class='ec-lmtt-10'>Acidanthera\Chardonnay </span>for Light Gray.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Default </span>— <span class='ec-lmtt-10'>Acidanthera\GoldenGate</span>.</li></ul>
     </li></ol>
<!-- l. 3716 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='debug-properties'><span class='titlemark'>8.4   </span> <a id='x1-450008.4'></a>Debug Properties</h4>
<!-- l. 3718 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-45002x1'>
     <!-- l. 3721 --><p class='noindent'><span class='ec-lmtt-10'>AppleDebug</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable writing the <span class='ec-lmtt-10'>boot.efi </span>debug log to the OpenCore log.
     </p><!-- l. 3726 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option only applies to 10.15.4 and newer.
     </p></li>
<li class='enumerate' id='x1-45004x2'>
     <!-- l. 3729 --><p class='noindent'><span class='ec-lmtt-10'>ApplePanic</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Save macOS kernel panic output to the OpenCore root partition.
     </p><!-- l. 3734 --><p class='noindent'>The file is saved as <span class='ec-lmtt-10'>panic-YYYY-MM-DD-HHMMSS.txt</span>. It is strongly recommended to set the <span class='ec-lmtt-10'>keepsyms=1 </span>boot
     argument to see debug symbols in the panic log. In cases where it is not present, the <span class='ec-lmtt-10'>kpdescribe.sh </span>utility
     (bundled with OpenCore) may be used to partially recover the stacktrace.
     </p><!-- l. 3739 --><p class='noindent'>Development and debug kernels produce more useful kernel panic logs. Consider downloading and installing the
     <span class='ec-lmtt-10'>KernelDebugKit </span>from <a href='https://developer.apple.com'>developer.apple.com</a> when debugging a problem. To activate a development kernel, the
     boot argument <span class='ec-lmtt-10'>kcsuffix=development </span>should be added. Use the <span class='ec-lmtt-10'>uname -a </span>command to ensure that the current
     loaded kernel is a development (or a debug) kernel.
     </p><!-- l. 3746 --><p class='noindent'>In cases where the OpenCore kernel panic saving mechanism is not used, kernel panic logs may still be found in
     the <span class='ec-lmtt-10'>/Library/Logs/DiagnosticReports </span>directory.
     </p><!-- l. 3749 --><p class='noindent'>Starting with macOS Catalina, kernel panics are stored in JSON format and thus need to be preprocessed before
     passing to <span class='ec-lmtt-10'>kpdescribe.sh</span>:
</p>
     <!-- l. 3752 -->
     <pre class='lstlisting' id='listing-5'><span class='label'><a id='x1-45005r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>cat</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>Kernel.panic </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>grep </span><span class='ec-lmtt-10'>macOSProcessedStackshotData </span><span class='ec-lmtt-10'>|</span> 
</span><span class='label'><a id='x1-45006r2'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>python3 </span><span class='ec-lmtt-10'>-c </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>import </span><span class='ec-lmtt-10'>json,sys;print(json.load(sys.stdin)["macOSPanicString"])</span><span class='ts1-lmtt10-'>'</span></span></pre>
     
     </li>
<li class='enumerate' id='x1-45008x3'><span class='ec-lmtt-10'>DisableWatchDog</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware may not succeed in booting the operating system quickly, especially in
     debug mode. This results in the watchdog timer aborting the process. This option turns off the watchdog
     timer.
     </li>
<li class='enumerate' id='x1-45010x4'><span class='ec-lmtt-10'>DisplayDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Delay in microseconds executed after every printed line visible onscreen (i.e. console).
     </li>
<li class='enumerate' id='x1-45012x5'>
     <!-- l. 3773 --><p class='noindent'><span class='ec-lmtt-10'>DisplayLevel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: EDK II debug level bitmask (sum) showed onscreen. Unless <span class='ec-lmtt-10'>Target </span>enables console (onscreen) printing,
     onscreen debug output will not be visible.
     </p><!-- l. 3780 --><p class='noindent'>The following levels are supported (discover more in <a href='https://github.com/acidanthera/audk/blob/master/MdePkg/Include/Library/DebugLib.h'>DebugLib.h</a>):
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000002 </span>(bit <span class='ec-lmtt-10'>1</span>) — <span class='ec-lmtt-10'>DEBUG_WARN </span>in <span class='ec-lmtt-10'>DEBUG</span>, <span class='ec-lmtt-10'>NOOPT</span>, <span class='ec-lmtt-10'>RELEASE</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000040 </span>(bit <span class='ec-lmtt-10'>6</span>) — <span class='ec-lmtt-10'>DEBUG_INFO </span>in <span class='ec-lmtt-10'>DEBUG</span>, <span class='ec-lmtt-10'>NOOPT</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00400000 </span>(bit <span class='ec-lmtt-10'>22</span>) — <span class='ec-lmtt-10'>DEBUG_VERBOSE </span>in custom builds.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x80000000 </span>(bit <span class='ec-lmtt-10'>31</span>) — <span class='ec-lmtt-10'>DEBUG_ERROR </span>in <span class='ec-lmtt-10'>DEBUG</span>, <span class='ec-lmtt-10'>NOOPT</span>, <span class='ec-lmtt-10'>RELEASE</span>.</li></ul>
     </li>
<li class='enumerate' id='x1-45014x6'>
     <!-- l. 3795 --><p class='noindent'><span class='ec-lmtt-10'>LogModules</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>*</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Filter log entries by module.
     </p><!-- l. 3800 --><p class='noindent'>This option filters logging generated by specific modules, both in the log and onscreen. Two modes are supported:
     </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>+ </span>— Positive filtering: Only present selected modules.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>- </span>— Negative filtering: Exclude selected modules.</li></ul>
     <!-- l. 3807 --><p class='noindent'>When multiple ones are selected, comma (<span class='ec-lmtt-10'>,</span>) should be used as the splitter. For instance, <span class='ec-lmtt-10'>+OCCPU,OCA,OCB </span>means <span class='ec-lmri-10'>only
     </span><span class='ec-lmtt-10'>OCCPU</span>, <span class='ec-lmtt-10'>OCA</span>, <span class='ec-lmtt-10'>OCB </span>being printed, while <span class='ec-lmtt-10'>-OCCPU,OCA,OCB </span>indicates these modules being filtered out (i.e. <span class='ec-lmri-10'>not</span>
     logged). When no symbol is specified, positive filtering (<span class='ec-lmtt-10'>+</span>) will be used. <span class='ec-lmtt-10'>* </span>indicates all modules being
                                                                                                  
                                                                                                  
     logged.
     </p><!-- l. 3813 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Acronyms of libraries can be found in the <a href='#x1-45021r8'><span class='ec-lmtt-10'>Libraries</span></a> section below.
     </p><!-- l. 3816 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Messages printed before the configuration of log protocol cannot be filtered.
     </p></li>
<li class='enumerate' id='x1-45016x7'>
     <!-- l. 3820 --><p class='noindent'><span class='ec-lmtt-10'>SysReport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Produce system report on ESP folder.
     </p><!-- l. 3825 --><p class='noindent'>This option will create a <span class='ec-lmtt-10'>SysReport </span>directory in the ESP partition unless already present. The directory will
     contain ACPI, SMBIOS, and audio codec dumps. Audio codec dumps require an audio backend driver to be
     loaded.
     </p><!-- l. 3829 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: To maintain system integrity, the <span class='ec-lmtt-10'>SysReport </span>option is <span class='ec-lmbx-10'>not </span>available in <span class='ec-lmtt-10'>RELEASE </span>builds. Use a <span class='ec-lmtt-10'>DEBUG </span>build if this
     option is required.
     </p></li>
<li class='enumerate' id='x1-45018x8'>
     <!-- l. 3833 --><p class='noindent'><span class='ec-lmtt-10'>Target</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: A bitmask (sum) of enabled logging targets. Logging output is hidden by default and this option must be
     set when such output is required, such as when debugging.
     </p><!-- l. 3840 --><p class='noindent'>The following logging targets are supported:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>(bit <span class='ec-lmtt-10'>0</span>) — Enable logging, otherwise all log is discarded.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>(bit <span class='ec-lmtt-10'>1</span>) — Enable basic console (onscreen) logging.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>(bit <span class='ec-lmtt-10'>2</span>) — Enable logging to Data Hub.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x08 </span>(bit <span class='ec-lmtt-10'>3</span>) — Enable serial port logging.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x10 </span>(bit <span class='ec-lmtt-10'>4</span>) — Enable UEFI variable logging.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x20 </span>(bit <span class='ec-lmtt-10'>5</span>) — Enable <span class='ec-lmtt-10'>non-volatile </span>UEFI variable logging.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x40 </span>(bit <span class='ec-lmtt-10'>6</span>) — Enable logging to file.</li></ul>
     <!-- l. 3853 --><p class='noindent'>Console logging prints less than the other variants. Depending on the build type (<span class='ec-lmtt-10'>RELEASE</span>, <span class='ec-lmtt-10'>DEBUG</span>, or <span class='ec-lmtt-10'>NOOPT</span>) different
     amount of logging may be read (from least to most).
     </p><!-- l. 3857 --><p class='noindent'>To obtain Data Hub logs, use the following command in macOS (Note that Data Hub logs do not log kernel and kext
     patches): </p><!-- l. 3859 -->
                                                                                                  
                                                                                                  
     <pre class='lstlisting' id='listing-6'><span class='label'><a id='x1-45019r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>ioreg</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-lw0 </span><span class='ec-lmtt-10'>-p </span><span class='ec-lmtt-10'>IODeviceTree </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>grep </span><span class='ec-lmtt-10'>boot-log </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>sort </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>sed </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>s/.*&lt;\(.*\)&gt;.*/\1/</span><span class='ts1-lmtt10-'>' </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtt-10'>xxd </span><span class='ec-lmtt-10'>-r </span><span class='ec-lmtt-10'>-p</span></span></pre>
     
     <!-- l. 3863 --><p class='noindent'>UEFI variable log does not include some messages and has no performance data. To maintain system integrity, the log
     size is limited to 32 kilobytes. Some types of firmware may truncate it much earlier or drop completely if they have no
     memory. Using the <span class='ec-lmtt-10'>non-volatile </span>flag will cause the log to be written to NVRAM flash after every printed
     line.
     </p><!-- l. 3868 --><p class='noindent'>To obtain UEFI variable logs, use the following command in macOS: </p><!-- l. 3869 -->
     <pre class='lstlisting' id='listing-7'><span class='label'><a id='x1-45020r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:boot-log </span><span class='ec-lmtt-10'>|</span> 
</span><span class='label'><a id='x1-45021r2'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>awk </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>{gsub(/%0d%0a%00/,"");gsub(/%0d%0a/,"\n")}1</span><span class='ts1-lmtt10-'>'</span></span></pre>
     
     <!-- l. 3874 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: Certain firmware appear to have defective NVRAM garbage collection. As a result, they may not be able to
     always free space after variable deletion. Do not enable <span class='ec-lmtt-10'>non-volatile </span>NVRAM logging on such devices unless specifically
     required.
     </p><!-- l. 3878 --><p class='noindent'>While the OpenCore boot log already contains basic version information including build type and date, this
     information may also be found in the <span class='ec-lmtt-10'>opencore-version </span>NVRAM variable even when boot logging is
     disabled.
     </p><!-- l. 3882 --><p class='noindent'>File logging will create a file named <span class='ec-lmtt-10'>opencore-YYYY-MM-DD-HHMMSS.txt </span>(in UTC) under the EFI volume root with log
     contents (the upper case letter sequence is replaced with date and time from the firmware). Please be warned
     that some file system drivers present in firmware are not reliable and may corrupt data when writing
     files through UEFI. Log writing is attempted in the safest manner and thus, is very slow. Ensure that
     <span class='ec-lmtt-10'>DisableWatchDog </span>is set to <span class='ec-lmtt-10'>true </span>when a slow drive is used. Try to avoid frequent use of this option when dealing
     with flash drives as large I/O amounts may speed up memory wear and render the flash drive unusable
     quicker.
     </p><!-- l. 3891 --><p class='noindent'>When interpreting the log, note that the lines are prefixed with a tag describing the relevant location (module) of the log
     line allowing better attribution of the line to the functionality.
     </p><!-- l. 3895 --><p class='noindent'>The list of currently used tags is as follows.
     </p><!-- l. 3897 --><p class='noindent'><span class='ec-lmbx-10'>Drivers and tools</span>: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>BMF </span>— OpenCanopy, bitmap font
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BS </span>— Bootstrap
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>GSTT </span>— GoptStop
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>HDA </span>— AudioDxe
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>KKT </span>— KeyTester
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>LNX </span>— OpenLinuxBoot
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>MMDD </span>— MmapDump
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCPAVP </span>— PavpProvision
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCRST </span>— ResetSystem
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCUI </span>— OpenCanopy
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC </span>— OpenCore main, also OcMainLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>VMOPT </span>— VerifyMemOpt</li></ul>
     <!-- l. 3915 --><p class='noindent'><span class='ec-lmbx-10'>Libraries</span>: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>AAPL </span>— OcLogAggregatorLib, Apple EfiBoot logging
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCABC </span>— OcAfterBootCompatLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCAE </span>— OcAppleEventLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCAK </span>— OcAppleKernelLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCAU </span>— OcAudioLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCA </span>—- OcAcpiLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCBP </span>— OcAppleBootPolicyLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCB </span>— OcBootManagementLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCLBT </span>— OcBlitLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCCL </span>— OcAppleChunkListLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCCPU </span>— OcCpuLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCC </span>— OcConsoleLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCDC </span>— OcDriverConnectionLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCDH </span>— OcDataHubLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCDI </span>— OcAppleDiskImageLib
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCDM </span>— OcDeviceMiscLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCFS </span>— OcFileLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCFV </span>— OcFirmwareVolumeLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCHS </span>— OcHashServicesLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCI4 </span>— OcAppleImg4Lib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCIC </span>— OcImageConversionLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCII </span>— OcInputLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCJS </span>— OcApfsLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCKM </span>— OcAppleKeyMapLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCL </span>— OcLogAggregatorLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCM </span>— OcMiscLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCMCO </span>— OcMachoLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCME </span>— OcHeciLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCMM </span>— OcMemoryLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCPE </span>— OcPeCoffLib, OcPeCoffExtLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCPI </span>— OcFileLib, partition info
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCPNG </span>— OcPngLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCRAM </span>— OcAppleRamDiskLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCRTC </span>— OcRtcLib
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCSB </span>— OcAppleSecureBootLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCSMB </span>— OcSmbiosLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCSMC </span>— OcSmcLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCST </span>— OcStorageLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCS </span>— OcSerializedLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCTPL </span>— OcTemplateLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCUC </span>— OcUnicodeCollationLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCUT </span>— OcAppleUserInterfaceThemeLib
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OCXML </span>— OcXmlLib</li></ul>
     </li></ol>
<!-- l. 3965 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='security-properties'><span class='titlemark'>8.5   </span> <a id='x1-460008.5'></a>Security Properties</h4>
<!-- l. 3967 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-46002x1'>
     <!-- l. 3970 --><p class='noindent'><span class='ec-lmtt-10'>AllowSetDefault</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Allow <span class='ec-lmtt-10'>CTRL+Enter </span>and <span class='ec-lmtt-10'>CTRL+Index </span>handling to set the default boot option in the OpenCore
     picker.
     </p><!-- l. 3976 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: May be used in combination with <span class='ec-lmtt-10'>Shift+Enter </span>or <span class='ec-lmtt-10'>Shift+Index </span>when <span class='ec-lmtt-10'>PollAppleHotKeys </span>is enabled.
     </p><!-- l. 3980 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: In order to support systems with unresponsive modifiers during preboot (which includes <span class='ec-lmtt-10'>V1 </span>and <span class='ec-lmtt-10'>V2
     </span><span class='ec-lmtt-10'>KeySupport </span>mode on some firmware) OpenCore also allows holding the <span class='ec-lmtt-10'>=/+ </span>key in order to trigger ‘set default’
     mode.
     </p></li>
<li class='enumerate' id='x1-46004x2'>
     <!-- l. 3985 --><p class='noindent'><span class='ec-lmtt-10'>ApECID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apple Enclave Identifier.
     </p><!-- l. 3990 --><p class='noindent'>Setting this value to any non-zero 64-bit integer will allow using personalised Apple Secure Boot identifiers. To
     use this setting, generate a random 64-bit number with a cryptographically secure random number generator.
     As an alternative, the first 8 bytes of <span class='ec-lmtt-10'>SystemUUID </span>can be used for <span class='ec-lmtt-10'>ApECID</span>, this is found in macOS 11 for Macs
     without the T2 chip.
     </p><!-- l. 3997 --><p class='noindent'>With this value set and <span class='ec-lmtt-10'>SecureBootModel </span>valid (and not <span class='ec-lmtt-10'>Disabled</span>), it is possible to achieve <a href='https://support.apple.com/en-us/HT208330'><span class='ec-lmtt-10'>Full Security</span></a> of
     Apple Secure Boot.
     </p><!-- l. 4002 --><p class='noindent'>To start using personalised Apple Secure Boot, the operating system must be reinstalled or personalised. Until
     the operating system is personalised, only macOS DMG recovery can be loaded. In cases where DMG recovery
     is missing, it can be downloaded by using the <span class='ec-lmtt-10'>macrecovery </span>utility and saved in <span class='ec-lmtt-10'>com.apple.recovery.boot </span>as
     explained in the <a href='#x1-98010x5'>Tips and Tricks</a> section. Note that <a href='#x1-46017x5'>DMG loading</a> needs to be set to <span class='ec-lmtt-10'>Signed </span>to use any DMG
     with Apple Secure Boot.
     </p><!-- l. 4011 --><p class='noindent'>To personalise an existing operating system, use the <span class='ec-lmtt-10'>bless </span>command after loading to macOS DMG recovery.
     Mount the system volume partition, unless it has already been mounted, and execute the following command:
</p>
     <!-- l. 4015 -->
     <pre class='lstlisting' id='listing-8'><span class='label'><a id='x1-46005r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>bless</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>--folder </span><span class='ec-lmtt-10'>"/Volumes/Macintosh </span><span class='ec-lmtt-10'>HD/System/Library/CoreServices" </span><span class='ec-lmtt-10'>\</span> 
</span><span class='label'><a id='x1-46006r2'></a></span><span style='color:#000000'>  <span class='ec-lmtt-10'>--bootefi </span><span class='ec-lmtt-10'>--personalize</span></span></pre>
     
     <!-- l. 4020 --><p class='noindent'>On macOS 11 and newer the dedicated <span class='ec-lmtt-10'>x86legacy </span>model always uses <span class='ec-lmtt-10'>ApECID</span>. When this configuration setting is left as <span class='ec-lmtt-10'>0</span>
     first 8 bytes of <span class='ec-lmtt-10'>system-id </span>variable are used instead.
     </p><!-- l. 4024 --><p class='noindent'>On macOS versions before macOS 11, which introduced a dedicated <span class='ec-lmtt-10'>x86legacy </span>model for models without the T2 chip,
     personalised Apple Secure Boot may not work as expected. When reinstalling the operating system, the macOS Installer
     from macOS 10.15 and older will often run out of free memory on the <span class='ec-lmtt-10'>/var/tmp </span>partition when trying to install macOS
     with the personalised Apple Secure Boot. Soon after downloading the macOS installer image, an <span class='ec-lmtt-10'>Unable to verify
     </span><span class='ec-lmtt-10'>macOS </span>error message will appear.
     </p><!-- l. 4032 --><p class='noindent'>To workaround this issue, allocate a dedicated RAM disk of 2 MBs for macOS personalisation by entering the following
     commands in the macOS recovery terminal before starting the installation:
</p>
     <!-- l. 4035 -->
     <pre class='lstlisting' id='listing-9'><span class='label'><a id='x1-46007r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>disk</span></span><span style='color:#000000'><span class='ec-lmtt-10'>=</span></span><span style='color:#000000'><span class='ec-lmtt-10'>$</span></span><span style='color:#000000'><span class='ec-lmtt-10'>(</span></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>attach </span><span class='ec-lmtt-10'>-nomount </span><span class='ec-lmtt-10'>ram://4096)</span> 
</span><span class='label'><a id='x1-46008r2'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>diskutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>erasevolume </span><span class='ec-lmtt-10'>HFS+ </span><span class='ec-lmtt-10'>SecureBoot </span><span class='ec-lmtt-10'>$disk</span> 
</span><span class='label'><a id='x1-46009r3'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>diskutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>unmount </span><span class='ec-lmtt-10'>$disk</span> 
</span><span class='label'><a id='x1-46010r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>mkdir</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>/var/tmp/OSPersonalizationTemp</span> 
</span><span class='label'><a id='x1-46011r5'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>diskutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>mount </span><span class='ec-lmtt-10'>-mountpoint </span><span class='ec-lmtt-10'>/var/tmp/OSPersonalizationTemp </span><span class='ec-lmtt-10'>$disk</span></span></pre>
     
     </li>
<li class='enumerate' id='x1-46013x3'>
     <!-- l. 4044 --><p class='noindent'><span class='ec-lmtt-10'>AuthRestart</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable <span class='ec-lmtt-10'>VirtualSMC</span>-compatible authenticated restart.
     </p><!-- l. 4049 --><p class='noindent'>Authenticated restart is a way to reboot FileVault 2 enabled macOS without entering the password. A dedicated terminal
     command can be used to perform authenticated restarts: <span class='ec-lmtt-10'>sudo fdesetup authrestart</span>. It is also used when installing
     operating system updates.
     </p><!-- l. 4053 --><p class='noindent'>VirtualSMC performs authenticated restarts by splitting and saving disk encryption keys between NVRAM and RTC,
     which despite being removed as soon as OpenCore starts, may be considered a security risk and thus is
     optional.
     </p></li>
<li class='enumerate' id='x1-46015x4'>
                                                                                                  
                                                                                                  
     <!-- l. 4058 --><p class='noindent'><span class='ec-lmtt-10'>BlacklistAppleUpdate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Ignore boot options trying to update Apple peripheral firmware (e.g. <span class='ec-lmtt-10'>MultiUpdater.efi</span>).
     </p><!-- l. 4064 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Certain operating systems, such as macOS Big Sur, are <a href='https://github.com/acidanthera/bugtracker/issues/1255'>incapable</a> of disabling firmware updates by using the
     <span class='ec-lmtt-10'>run-efi-updater </span>NVRAM variable.
     </p></li>
<li class='enumerate' id='x1-46017x5'>
     <!-- l. 4068 --><p class='noindent'> <span class='ec-lmtt-10'>DmgLoading</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Signed</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Define Disk Image (DMG) loading policy used for macOS Recovery.
     </p><!-- l. 4074 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Disabled </span>— loading DMG images will fail. The <span class='ec-lmtt-10'>Disabled </span>policy will still let the macOS Recovery load in
         most cases as typically, there are <span class='ec-lmtt-10'>boot.efi </span>files compatible with Apple Secure Boot. Manually downloaded
         DMG images stored in <span class='ec-lmtt-10'>com.apple.recovery.boot </span>directories will not load, however.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Signed </span>— only Apple-signed DMG images will load. Due to the design of Apple Secure Boot, the <span class='ec-lmtt-10'>Signed</span>
         policy will let any Apple-signed macOS Recovery load regardless of the Apple Secure Boot state, which may
         not always be desired. While using signed DMG images is more desirable, verifying the image signature
         may slightly slow the boot time down (by up to 1 second).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Any </span>— any DMG images will mount as normal filesystems. The <span class='ec-lmtt-10'>Any </span>policy is strongly discouraged and will
         result in boot failures when Apple Secure Boot is active.</li></ul>
     </li>
<li class='enumerate' id='x1-46019x6'>
     <!-- l. 4094 --><p class='noindent'><span class='ec-lmtt-10'>EnablePassword</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable password protection to facilitate sensitive operations.
     </p><!-- l. 4099 --><p class='noindent'>Password protection ensures that sensitive operations such as booting a non-default operating system (e.g. macOS
     recovery or a tool), resetting NVRAM storage, trying to boot into a non-default mode (e.g. verbose mode or safe mode)
     are not allowed without explicit user authentication by a custom password. Currently, password and salt are hashed with
     5000000 iterations of SHA-512.
     </p><!-- l. 4105 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This functionality is still under development and is not ready for production environments.
     </p></li>
<li class='enumerate' id='x1-46021x7'>
     <!-- l. 4109 --><p class='noindent'><span class='ec-lmtt-10'>ExposeSensitiveData</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x6</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sensitive data exposure bitmask (sum) to operating system.
</p>
                                                                                                  
                                                                                                  
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— Expose the printable booter path as a UEFI variable.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>— Expose the OpenCore version as a UEFI variable.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>— Expose the OpenCore version in the OpenCore picker menu title.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x08 </span>— Expose OEM information as a set of UEFI variables.</li></ul>
     <!-- l. 4122 --><p class='noindent'>The exposed booter path points to OpenCore.efi or its booter depending on the load order. To obtain the booter path,
     use the following command in macOS: </p><!-- l. 4124 -->
     <pre class='lstlisting' id='listing-10'><span class='label'><a id='x1-46022r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:boot-path</span></span></pre>
     
     <!-- l. 4128 --><p class='noindent'>To use a booter path to mount a booter volume, use the following command in macOS: </p><!-- l. 4129 -->
     <pre class='lstlisting' id='listing-11'><span class='label'><a id='x1-46023r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>u</span></span><span style='color:#000000'><span class='ec-lmtt-10'>=</span></span><span style='color:#000000'><span class='ec-lmtt-10'>$</span></span><span style='color:#000000'><span class='ec-lmtt-10'>(</span></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:boot-path </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>sed </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>s/.*GPT,\([^,]*\),.*/\1/</span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>); </span><span class='ec-lmtt-10'>\</span> 
</span><span class='label'><a id='x1-46024r2'></a></span><span style='color:#000000'>  <span class='ec-lmtk-10'>if </span><span class='ec-lmtt-10'>[ </span><span class='ec-lmtt-10'>"$u" </span><span class='ec-lmtt-10'>!= </span><span class='ec-lmtt-10'>"" </span><span class='ec-lmtt-10'>]; </span><span class='ec-lmtk-10'>then </span><span class='ec-lmtk-10'>sudo </span><span class='ec-lmtk-10'>diskutil </span><span class='ec-lmtt-10'>mount </span><span class='ec-lmtt-10'>$u </span><span class='ec-lmtt-10'>; </span><span class='ec-lmtt-10'>fi</span></span></pre>
     
     <!-- l. 4134 --><p class='noindent'>To obtain the current OpenCore version, use the following command in macOS: </p><!-- l. 4135 -->
     <pre class='lstlisting' id='listing-12'><span class='label'><a id='x1-46025r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:opencore-version</span></span></pre>
     
     <!-- l. 4138 --><p class='noindent'>If the OpenCore version is not exposed the variable will contain <span class='ec-lmtt-10'>UNK-000-0000-00-00 </span>sequence.
     </p><!-- l. 4141 --><p class='noindent'>To obtain OEM information, use the following commands in macOS: </p><!-- l. 4142 -->
     <pre class='lstlisting' id='listing-13'><span class='label'><a id='x1-46026r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:oem-product </span><span class='ec-lmtti-10'># </span><span class='ec-lmtti-10'>SMBIOS </span><span class='ec-lmtti-10'>Type1 </span><span class='ec-lmtti-10'>ProductName</span> 
</span><span class='label'><a id='x1-46027r2'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:oem-vendor </span> <span class='ec-lmtti-10'># </span><span class='ec-lmtti-10'>SMBIOS </span><span class='ec-lmtti-10'>Type2 </span><span class='ec-lmtti-10'>Manufacturer</span> 
</span><span class='label'><a id='x1-46028r3'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>nvram</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:oem-board </span>  <span class='ec-lmtti-10'># </span><span class='ec-lmtti-10'>SMBIOS </span><span class='ec-lmtti-10'>Type2 </span><span class='ec-lmtti-10'>ProductName</span></span></pre>
     
     </li>
<li class='enumerate' id='x1-46030x8'><span class='ec-lmtt-10'>HaltLevel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x80000000 </span>(<span class='ec-lmtt-10'>DEBUG_ERROR</span>)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: EDK II debug level bitmask (sum) causing CPU to halt (stop execution) after obtaining a message of
     <span class='ec-lmtt-10'>HaltLevel</span>. Possible values match <span class='ec-lmtt-10'>DisplayLevel </span>values.
     </li>
<li class='enumerate' id='x1-46032x9'><span class='ec-lmtt-10'>PasswordHash</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data </span>64 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: all zero<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Password hash used when <span class='ec-lmtt-10'>EnabledPassword </span>is set.
     </li>
<li class='enumerate' id='x1-46034x10'><span class='ec-lmtt-10'>PasswordSalt</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Password salt used when <span class='ec-lmtt-10'>EnabledPassword </span>is set.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-46036x11'>
     <!-- l. 4168 --><p class='noindent'> <span class='ec-lmtt-10'>Vault</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Secure</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enables the OpenCore vaulting mechanism.
     </p><!-- l. 4174 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Optional </span>— require nothing, no vault is enforced, insecure.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Basic </span>— require <span class='ec-lmtt-10'>vault.plist </span>file present in <span class='ec-lmtt-10'>OC </span>directory. This provides basic filesystem integrity verification
         and may protect from unintentional filesystem corruption.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Secure </span>— require <span class='ec-lmtt-10'>vault.sig </span>signature file for <span class='ec-lmtt-10'>vault.plist </span>in <span class='ec-lmtt-10'>OC </span>directory. This includes <span class='ec-lmtt-10'>Basic </span>integrity
         checking but also attempts to build a trusted bootchain.</li></ul>
     <!-- l. 4187 --><p class='noindent'>The <span class='ec-lmtt-10'>vault.plist </span>file should contain SHA-256 hashes for all files used by OpenCore. The presence of this file is
     highly recommended to ensure that unintentional file modifications (including filesystem corruption) do
     not go unnoticed. To create this file automatically, use the <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/CreateVault'><span class='ec-lmtt-10'>create_vault.sh</span></a> script. Notwithstanding
     the underlying file system, the path names and cases between <span class='ec-lmtt-10'>config.plist </span>and <span class='ec-lmtt-10'>vault.plist </span>must
     match.
     </p><!-- l. 4194 --><p class='noindent'>The <span class='ec-lmtt-10'>vault.sig </span>file should contain a raw 256 byte RSA-2048 signature from a SHA-256 hash of <span class='ec-lmtt-10'>vault.plist</span>. The
     signature is verified against the public key embedded into <span class='ec-lmtt-10'>OpenCore.efi</span>.
     </p><!-- l. 4198 --><p class='noindent'>To embed the public key, either one of the following should be performed:
</p>
         <ul class='itemize1'>
         <li class='itemize'>Provide public key during the <span class='ec-lmtt-10'>OpenCore.efi </span>compilation in <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Platform/OpenCore/OpenCoreVault.c'><span class='ec-lmtt-10'>OpenCoreVault.c</span></a> file.
         </li>
         <li class='itemize'>Binary patch <span class='ec-lmtt-10'>OpenCore.efi </span>replacing zeroes with the public key between <span class='ec-lmtt-10'>=BEGIN OC VAULT= </span>and <span class='ec-lmtt-10'>==END
         </span><span class='ec-lmtt-10'>OC VAULT== </span>ASCII markers.</li></ul>
     <!-- l. 4208 --><p class='noindent'>The RSA public key 520 byte format description can be found in Chromium OS documentation. To convert the public
     key from X.509 certificate or from PEM file use <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/CreateVault'>RsaTool</a>.
     </p><!-- l. 4213 --><p class='noindent'>The complete set of commands to:
</p>
         <ul class='itemize1'>
         <li class='itemize'>Create <span class='ec-lmtt-10'>vault.plist</span>.
         </li>
         <li class='itemize'>Create a new RSA key (always do this to avoid loading old configuration).
         </li>
         <li class='itemize'>Embed RSA key into <span class='ec-lmtt-10'>OpenCore.efi</span>.
         </li>
         <li class='itemize'>Create <span class='ec-lmtt-10'>vault.sig</span>.</li></ul>
     <!-- l. 4223 --><p class='noindent'>Can look as follows: </p><!-- l. 4224 -->
     <pre class='lstlisting' id='listing-14'><span class='label'><a id='x1-46037r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>cd</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>/Volumes/EFI/EFI/OC</span> 
</span><span class='label'><a id='x1-46038r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>path</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>to</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>create_vault</span></span><span style='color:#000000'><span class='ec-lmtt-10'>.</span></span><span style='color:#000000'><span class='ec-lmtt-10'>sh</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>.</span> 
</span><span class='label'><a id='x1-46039r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>path</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>to</span></span><span style='color:#000000'><span class='ec-lmtt-10'>/</span></span><span style='color:#000000'><span class='ec-lmtt-10'>RsaTool</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-sign </span><span class='ec-lmtt-10'>vault.plist </span><span class='ec-lmtt-10'>vault.sig </span><span class='ec-lmtt-10'>vault.pub</span> 
</span><span class='label'><a id='x1-46040r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>off</span></span><span style='color:#000000'><span class='ec-lmtt-10'>=</span></span><span style='color:#000000'><span class='ec-lmtt-10'>$</span></span><span style='color:#000000'><span class='ec-lmtt-10'>((</span></span><span style='color:#000000'><span class='ec-lmtt-10'>$</span></span><span style='color:#000000'><span class='ec-lmtt-10'>(</span></span><span style='color:#000000'><span class='ec-lmtk-10'>strings</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-a </span><span class='ec-lmtt-10'>-t </span><span class='ec-lmtt-10'>d </span><span class='ec-lmtt-10'>OpenCore.efi </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>grep </span><span class='ec-lmtt-10'>"=BEGIN </span><span class='ec-lmtt-10'>OC </span><span class='ec-lmtt-10'>VAULT=" </span><span class='ec-lmtt-10'>| </span><span class='ec-lmtk-10'>cut </span><span class='ec-lmtt-10'>-f1 </span><span class='ec-lmtt-10'>-d</span><span class='ts1-lmtt10-'>' </span><span class='ts1-lmtt10-'>'</span><span class='ec-lmtt-10'>)+16))</span> 
</span><span class='label'><a id='x1-46041r5'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>dd</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>of=OpenCore.efi </span><span class='ec-lmtk-10'>if</span><span class='ec-lmtt-10'>=vault.pub </span><span class='ec-lmtt-10'>bs=1 </span><span class='ec-lmtt-10'>seek=$off </span><span class='ec-lmtt-10'>count=528 </span><span class='ec-lmtt-10'>conv=notrunc</span> 
</span><span class='label'><a id='x1-46042r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>rm</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>vault.pub</span></span></pre>
     
     <!-- l. 4233 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: While it may appear obvious, an external method is required to verify <span class='ec-lmtt-10'>OpenCore.efi </span>and <span class='ec-lmtt-10'>BOOTx64.efi </span>for
     secure boot path. For this, it is recommended to enable UEFI SecureBoot using a custom certificate and to sign
     <span class='ec-lmtt-10'>OpenCore.efi </span>and <span class='ec-lmtt-10'>BOOTx64.efi </span>with a custom key. More details on customising secure boot on modern firmware can be
     found in the <a href='https://habr.com/post/273497/'>Taming UEFI SecureBoot</a> paper (in Russian).
     </p><!-- l. 4241 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Regardless of this option, <span class='ec-lmtt-10'>vault.plist </span>is always used when present, and both <span class='ec-lmtt-10'>vault.plist </span>and <span class='ec-lmtt-10'>vault.sig </span>are
     used and required when a public key is embedded into <span class='ec-lmtt-10'>OpenCore.efi</span>, and errors will abort the boot process in either
     case. Setting this option allows OpenCore to warn the user if the configuration is not as required to achieve an expected
     higher security level.
     </p></li>
<li class='enumerate' id='x1-46044x12'>
     <!-- l. 4248 --><p class='noindent'><span class='ec-lmtt-10'>ScanPolicy</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x10F0103</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Define operating system detection policy.
     </p><!-- l. 4253 --><p class='noindent'>This value allows preventing scanning (and booting) untrusted sources based on a bitmask (sum) of a set of flags. As it is
     not possible to reliably detect every file system or device type, this feature cannot be fully relied upon in open
     environments, and additional measures are to be applied.
     </p><!-- l. 4259 --><p class='noindent'>Third party drivers may introduce additional security (and performance) consideratons following the provided scan
     policy. The active Scan policy is exposed in the <span class='ec-lmtt-10'>scan-policy </span>variable of <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102</span>
     GUID for UEFI Boot Services only.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000001 </span>(bit <span class='ec-lmtt-10'>0</span>) — <span class='ec-lmtt-10'>OC_SCAN_FILE_SYSTEM_LOCK</span>, restricts scanning to only known file systems defined
         as a part of this policy. File system drivers may not be aware of this policy. Hence, to avoid mounting of
         undesired file systems, drivers for such file systems should not be loaded. This bit does not affect DMG
         mounting, which may have any file system. Known file systems are prefixed with <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000002 </span>(bit <span class='ec-lmtt-10'>1</span>) — <span class='ec-lmtt-10'>OC_SCAN_DEVICE_LOCK</span>, restricts scanning to only known device types defined as a
         part of this policy. It is not always possible to detect protocol tunneling, so be aware that on some systems,
         it may be possible for e.g. USB HDDs to be recognised as SATA instead. Cases like this must be reported.
         Known device types are prefixed with <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000100 </span>(bit <span class='ec-lmtt-10'>8</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_APFS</span>, allows scanning of APFS file system.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000200 </span>(bit <span class='ec-lmtt-10'>9</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_HFS</span>, allows scanning of HFS file system.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000400 </span>(bit <span class='ec-lmtt-10'>10</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_ESP</span>, allows scanning of EFI System Partition file system.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000800 </span>(bit <span class='ec-lmtt-10'>11</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_NTFS</span>, allows scanning of NTFS (Msft Basic Data) file system.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00001000 </span>(bit <span class='ec-lmtt-10'>12</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_LINUX_ROOT</span>, allows scanning of Linux Root file systems.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00002000 </span>(bit <span class='ec-lmtt-10'>13</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_LINUX_DATA</span>, allows scanning of Linux Data file systems.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00004000 </span>(bit <span class='ec-lmtt-10'>14</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_XBOOTLDR</span>, allows scanning the Extended Boot Loader Partition
         as defined by the <a href='https://systemd.io/BOOT_LOADER_SPECIFICATION/'>Boot Loader Specification</a>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00010000 </span>(bit <span class='ec-lmtt-10'>16</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SATA</span>, allow scanning SATA devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00020000 </span>(bit <span class='ec-lmtt-10'>17</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SASEX</span>, allow scanning SAS and Mac NVMe devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00040000 </span>(bit <span class='ec-lmtt-10'>18</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SCSI</span>, allow scanning SCSI devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00080000 </span>(bit <span class='ec-lmtt-10'>19</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_NVME</span>, allow scanning NVMe devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00100000 </span>(bit <span class='ec-lmtt-10'>20</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_ATAPI</span>, allow scanning CD/DVD devices and old SATA.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00200000 </span>(bit <span class='ec-lmtt-10'>21</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_USB</span>, allow scanning USB devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00400000 </span>(bit <span class='ec-lmtt-10'>22</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_FIREWIRE</span>, allow scanning FireWire devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00800000 </span>(bit <span class='ec-lmtt-10'>23</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SDCARD</span>, allow scanning card reader devices.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x01000000 </span>(bit <span class='ec-lmtt-10'>24</span>) — <span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_PCI</span>, allow scanning devices directly connected to PCI bus
         (e.g. VIRTIO).</li></ul>
     <!-- l. 4312 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Given the above description, a value of <span class='ec-lmtt-10'>0xF0103 </span>is expected to do the following:
</p>
         <ul class='itemize1'>
         <li class='itemize'>Permit scanning SATA, SAS, SCSI, and NVMe devices with APFS file systems.
         </li>
         <li class='itemize'>Prevent scanning any devices with HFS or FAT32 file systems.
         </li>
         <li class='itemize'>Prevent scanning APFS file systems on USB, CD, and FireWire drives.</li></ul>
     <!-- l. 4321 --><p class='noindent'>The combination reads as: </p>
         <ul class='itemize1'>
                                                                                                  
                                                                                                  
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_FILE_SYSTEM_LOCK</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_DEVICE_LOCK</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_ALLOW_FS_APFS</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SATA</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SASEX</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_SCSI</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OC_SCAN_ALLOW_DEVICE_NVME</span></li></ul>
     </li>
<li class='enumerate' id='x1-46046x13'>
     <!-- l. 4333 --><p class='noindent'> <span class='ec-lmtt-10'>SecureBootModel</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Default</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apple Secure Boot hardware model.
     </p><!-- l. 4339 --><p class='noindent'>Sets Apple Secure Boot hardware model and policy. Specifying this value defines which operating systems will be
     bootable. Operating systems shipped before the specified model was released will not boot.
     </p><!-- l. 4344 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Default </span>— Matching model for current SMBIOS.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Disabled </span>— No model, Secure Boot will be disabled.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j137 </span>— <span class='ec-lmtt-10'>iMacPro1,1 (December 2017). Minimum macOS 10.13.2 (17C2111)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j680 </span>— <span class='ec-lmtt-10'>MacBookPro15,1 (July 2018). Minimum macOS 10.13.6 (17G2112)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j132 </span>— <span class='ec-lmtt-10'>MacBookPro15,2 (July 2018). Minimum macOS 10.13.6 (17G2112)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j174 </span>— <span class='ec-lmtt-10'>Macmini8,1 (October 2018). Minimum macOS 10.14 (18A2063)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j140k </span>— <span class='ec-lmtt-10'>MacBookAir8,1 (October 2018). Minimum macOS 10.14.1 (18B2084)</span>
         </li>
                                                                                                  
                                                                                                  
         <li class='itemize'><span class='ec-lmtt-10'>j780 </span>— <span class='ec-lmtt-10'>MacBookPro15,3 (May 2019). Minimum macOS 10.14.5 (18F132)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j213 </span>— <span class='ec-lmtt-10'>MacBookPro15,4 (July 2019). Minimum macOS 10.14.5 (18F2058)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j140a </span>— <span class='ec-lmtt-10'>MacBookAir8,2 (July 2019). Minimum macOS 10.14.5 (18F2058)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j152f </span>— <span class='ec-lmtt-10'>MacBookPro16,1 (November 2019). Minimum macOS 10.15.1 (19B2093)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j160 </span>— <span class='ec-lmtt-10'>MacPro7,1 (December 2019). Minimum macOS 10.15.1 (19B88)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j230k </span>— <span class='ec-lmtt-10'>MacBookAir9,1 (March 2020). Minimum macOS 10.15.3 (19D2064)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j214k </span>— <span class='ec-lmtt-10'>MacBookPro16,2 (May 2020). Minimum macOS 10.15.4 (19E2269)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j223 </span>— <span class='ec-lmtt-10'>MacBookPro16,3 (May 2020). Minimum macOS 10.15.4 (19E2265)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j215 </span>— <span class='ec-lmtt-10'>MacBookPro16,4 (June 2020). Minimum macOS 10.15.5 (19F96)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j185 </span>— <span class='ec-lmtt-10'>iMac20,1 (August 2020). Minimum macOS 10.15.6 (19G2005)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>j185f </span>— <span class='ec-lmtt-10'>iMac20,2 (August 2020). Minimum macOS 10.15.6 (19G2005)</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>x86legacy </span>— <span class='ec-lmtt-10'>Macs without T2 chip and VMs. Minimum macOS 11.0.1 (20B29)</span></li></ul>
     <!-- l. 4369 --><p class='noindent'><span class='ec-lmri-10'>Warning</span>: Not all Apple Secure Boot models are supported on all hardware configurations.
     </p><!-- l. 4371 --><p class='noindent'>Apple Secure Boot appeared in macOS 10.13 on models with T2 chips. Prior to macOS 12 <span class='ec-lmtt-10'>PlatformInfo </span>and
     <span class='ec-lmtt-10'>SecureBootModel </span>were independent, allowing Apple Secure Boot can be used with any SMBIOS with and without T2.
     Starting with macOS 12 <span class='ec-lmtt-10'>SecureBootModel </span>must match the SMBIOS Mac model. <span class='ec-lmtt-10'>Default </span>model derives the model based
     on SMBIOS board identifier, either set automatically via the <span class='ec-lmtt-10'>Generic </span>section or set manually via the
     <span class='ec-lmtt-10'>SMBIOS </span>section. If there is no board identifier override the model will be derived heuristically from OEM
     SMBIOS.
     </p><!-- l. 4379 --><p class='noindent'>Setting <span class='ec-lmtt-10'>SecureBootModel </span>to any valid value but <span class='ec-lmtt-10'>Disabled </span>is equivalent to <a href='https://support.apple.com/en-us/HT208330'><span class='ec-lmtt-10'>Medium Security</span></a> of Apple Secure Boot. The
     <span class='ec-lmtt-10'>ApECID </span>value must also be specified to achieve <span class='ec-lmtt-10'>Full Security</span>. Check <span class='ec-lmtt-10'>ForceSecureBootScheme </span>when using Apple Secure
     Boot on a virtual machine.
     </p><!-- l. 4386 --><p class='noindent'>Note that enabling Apple Secure Boot is demanding on invalid configurations, faulty macOS installations, and on
     unsupported setups.
     </p><!-- l. 4389 --><p class='noindent'>Things to consider:
     </p><!-- l. 4391 --><p class='noindent'>
         </p><ol class='enumerate2'>
<li class='enumerate' id='x1-46048x1'>As with T2 Macs, all unsigned kernel extensions as well as several signed kernel extensions, including
         NVIDIA Web Drivers, cannot be installed.
                                                                                                  
                                                                                                  
         </li>
<li class='enumerate' id='x1-46050x2'>The list of cached kernel extensions may be different, resulting in a need to change the list of <span class='ec-lmtt-10'>Added </span>or
         <span class='ec-lmtt-10'>Forced </span>kernel extensions. For example, <span class='ec-lmtt-10'>IO80211Family </span>cannot be injected in this case.
         </li>
<li class='enumerate' id='x1-46052x3'>System volume alterations on operating systems with sealing, such as macOS 11, may result in the operating
         system being unbootable. Do not try to disable system volume encryption unless Apple Secure Boot is
         disabled.
         </li>
<li class='enumerate' id='x1-46054x4'>Boot failures might occur when the platform requires certain settings, but they have not been enabled
         because the associated issues were not discovered earlier. Be extra careful with <span class='ec-lmtt-10'>IgnoreInvalidFlexRatio</span>
         or <span class='ec-lmtt-10'>HashServices</span>.
         </li>
<li class='enumerate' id='x1-46056x5'>Operating systems released before Apple Secure Boot was released (e.g. macOS 10.12 or earlier), will still
         boot until UEFI Secure Boot is enabled. This is so because Apple Secure Boot treats these as incompatible
         and they are then handled by the firmware (as Microsoft Windows is).
         </li>
<li class='enumerate' id='x1-46058x6'>On older CPUs (e.g. before Sandy Bridge), enabling Apple Secure Boot might cause slightly slower loading
         (by up to 1 second).
         </li>
<li class='enumerate' id='x1-46060x7'>As the <span class='ec-lmtt-10'>Default </span>value will increase with time to support the latest major released operating system, it is
         not recommended to use the <span class='ec-lmtt-10'>ApECID </span>and the <span class='ec-lmtt-10'>Default </span>settings together.
         </li>
<li class='enumerate' id='x1-46062x8'>Installing macOS with Apple Secure Boot enabled is not possible while using HFS+ target volumes. This
         may include HFS+ formatted drives when no spare APFS drive is available.</li></ol>
     <!-- l. 4417 --><p class='noindent'>The installed operating system may have sometimes outdated Apple Secure Boot manifests on the <span class='ec-lmtt-10'>Preboot </span>partition,
     resulting in boot failures. This is likely to be the case when an “OCB: Apple Secure Boot prohibits this boot entry,
     enforcing!” message is logged.
     </p><!-- l. 4422 --><p class='noindent'>When this happens, either reinstall the operating system or copy the manifests (files with <span class='ec-lmtt-10'>.im4m </span>extension, such as
     <span class='ec-lmtt-10'>boot.efi.j137.im4m</span>) from <span class='ec-lmtt-10'>/usr/standalone/i386 </span>to <span class='ec-lmtt-10'>/Volumes/Preboot/&lt;UUID&gt;/System/Library/CoreServices</span>.
     Here, <span class='ec-lmtt-10'>&lt;UUID&gt; </span>is the system volume identifier. On HFS+ installations, the manifests should be copied to
     <span class='ec-lmtt-10'>/System/Library/CoreServices </span>on the system volume.
     </p><!-- l. 4429 --><p class='noindent'>For more details on how to configure Apple Secure Boot with UEFI Secure Boot, refer to the <a href='#uefi-secure-boot'>UEFI Secure Boot</a>
     section.
</p>
     </li></ol>
<!-- l. 4434 --><p class='noindent'>
</p>
                                                                                                  
                                                                                                  
<h4 class='subsectionHead' id='serial-properties'><span class='titlemark'>8.6   </span> <a id='x1-470008.6'></a>Serial Properties</h4>
<!-- l. 4436 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-47002x1'>
     <!-- l. 4438 --><p class='noindent'><span class='ec-lmtt-10'>Custom</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update serial port properties in <span class='ec-lmtt-10'>BaseSerialPortLib16550</span>.
     </p><!-- l. 4442 --><p class='noindent'>This section lists the PCD values that are used by the <span class='ec-lmtt-10'>BaseSerialPortLib16550</span>. When option <span class='ec-lmtt-10'>Override </span>is set
     to <span class='ec-lmtt-10'>false</span>, this dictionary is optional.
     </p></li>
<li class='enumerate' id='x1-47004x2'>
     <!-- l. 4446 --><p class='noindent'><span class='ec-lmtt-10'>Init</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform serial port initialisation.
     </p><!-- l. 4451 --><p class='noindent'>This option will perform serial port initialisation within OpenCore prior to enabling (any) debug logging.
     </p><!-- l. 4454 --><p class='noindent'>Refer to the <a href='#debugging1'><span class='ec-lmtt-10'>Debugging</span></a> section for details.
     </p></li>
<li class='enumerate' id='x1-47006x3'>
     <!-- l. 4457 --><p class='noindent'><span class='ec-lmtt-10'>Override</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Override serial port properties. When this option is set to <span class='ec-lmtt-10'>false</span>, no keys from <span class='ec-lmtt-10'>Custom </span>will be
     overridden.
     </p><!-- l. 4463 --><p class='noindent'>This option will override serial port properties listed in the <a href='#serial-custom-properties'><span class='ec-lmtt-10'>Serial Custom Properties</span></a> section below.
</p>
     </li></ol>
<!-- l. 4468 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='serial-custom-properties'><span class='titlemark'>8.6.1   </span> <a id='x1-480008.6.1'></a>Serial Custom Properties</h5>
<!-- l. 4470 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-48002x1'>
     <!-- l. 4472 --><p class='noindent'><span class='ec-lmtt-10'>BaudRate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>115200</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set the baud rate for serial port.
     </p><!-- l. 4477 --><p class='noindent'>This  option  will  override  the  value  of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialBaudRate </span>defined  in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48004x2'>
                                                                                                  
                                                                                                  
     <!-- l. 4481 --><p class='noindent'><span class='ec-lmtt-10'>ClockRate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>1843200</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set the clock rate for serial port.
     </p><!-- l. 4486 --><p class='noindent'>This  option  will  override  the  value  of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialClockRate </span>defined  in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48006x3'>
     <!-- l. 4490 --><p class='noindent'><span class='ec-lmtt-10'>DetectCable</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable serial port cable detection.
     </p><!-- l. 4495 --><p class='noindent'>This option will override the value of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialDetectCable </span>defined in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48008x4'>
     <!-- l. 4499 --><p class='noindent'><span class='ec-lmtt-10'>ExtendedTxFifoSize</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>64</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set the extended transmit FIFO size for serial port.
     </p><!-- l. 4504 --><p class='noindent'>This  option  will  override  the  value  of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialExtendedTxFifoSize</span>
     defined in <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48010x5'>
     <!-- l. 4508 --><p class='noindent'><span class='ec-lmtt-10'>FifoControl</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x07</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure serial port FIFO Control settings.
     </p><!-- l. 4513 --><p class='noindent'>This option will override the value of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialFifoControl </span>defined in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48012x6'>
     <!-- l. 4517 --><p class='noindent'><span class='ec-lmtt-10'>LineControl</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x07</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure serial port Line Control settings.
     </p><!-- l. 4522 --><p class='noindent'>This option will override the value of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialLineControl </span>defined in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48014x7'>
     <!-- l. 4526 --><p class='noindent'><span class='ec-lmtt-10'>PciDeviceInfo</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0xFF</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set PCI serial device information.
                                                                                                  
                                                                                                  
     </p><!-- l. 4531 --><p class='noindent'>This option will override the value of <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialPciDeviceInfo </span>defined in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p><!-- l. 4534 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The maximum allowed size of this option is 41 bytes. Refer to <a href='https://github.com/acidanthera/bugtracker/issues/1954#issuecomment-1084220743'>acidanthera/bugtracker#1954</a> for more
     details.
     </p><!-- l. 4538 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: This option can be set by running the <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/FindSerialPort'><span class='ec-lmtt-10'>FindSerialPort</span></a> tool.
     </p></li>
<li class='enumerate' id='x1-48016x8'>
     <!-- l. 4542 --><p class='noindent'><span class='ec-lmtt-10'>RegisterAccessWidth</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>8</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set serial port register access width.
     </p><!-- l. 4547 --><p class='noindent'>This  option  will  override  the  value  of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialRegisterAccessWidth</span>
     defined in <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48018x9'>
     <!-- l. 4551 --><p class='noindent'><span class='ec-lmtt-10'>RegisterBase</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x03F8</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set the base address of serial port registers.
     </p><!-- l. 4556 --><p class='noindent'>This option will override the value of <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialRegisterBase </span>defined in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48020x10'>
     <!-- l. 4560 --><p class='noindent'><span class='ec-lmtt-10'>RegisterStride</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set the serial port register stride in bytes.
     </p><!-- l. 4565 --><p class='noindent'>This option will override the value of <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialRegisterStride </span>defined
     in <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48022x11'>
     <!-- l. 4569 --><p class='noindent'><span class='ec-lmtt-10'>UseHardwareFlowControl</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable serial port hardware flow control.
     </p><!-- l. 4574 --><p class='noindent'>This option will override the value of <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialUseHardwareFlowControl</span>
     defined in <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
     </p></li>
<li class='enumerate' id='x1-48024x12'>
     <!-- l. 4578 --><p class='noindent'><span class='ec-lmtt-10'>UseMmio</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Indicate whether the serial port registers are in MMIO space.
                                                                                                  
                                                                                                  
     </p><!-- l. 4583 --><p class='noindent'>This  option  will  override  the  value  of  <span class='ec-lmtt-10'>gEfiMdeModulePkgTokenSpaceGuid.PcdSerialUseMmio </span>defined  in
     <a href='https://github.com/acidanthera/audk/blob/master/MdeModulePkg/MdeModulePkg.dec'>MdeModulePkg.dec</a>.
</p>
     </li></ol>
<!-- l. 4588 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='entry-properties'><span class='titlemark'>8.7   </span> <a id='x1-490008.7'></a>Entry Properties</h4>
<!-- l. 4590 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-49002x1'><span class='ec-lmtt-10'>Arguments</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used as boot arguments (load options) of the specified entry.
     </li>
<li class='enumerate' id='x1-49004x2'><span class='ec-lmtt-10'>Auxiliary</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>to hide this entry when <span class='ec-lmtt-10'>HideAuxiliary </span>is also set to <span class='ec-lmtt-10'>true</span>. Press the <span class='ec-lmtt-10'>Spacebar </span>key
     to enter “Extended Mode” and display the entry when hidden.
     </li>
<li class='enumerate' id='x1-49006x3'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide a human readable reference for the entry. Whether this
     value is used is implementation defined.
     </li>
<li class='enumerate' id='x1-49008x4'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set to <span class='ec-lmtt-10'>true </span>activate this entry.
     </li>
<li class='enumerate' id='x1-49010x5'><span class='ec-lmtt-10'>Flavour</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specify the content flavour for this entry. See <a href='#x1-44012x6'><span class='ec-lmtt-10'>OC_ATTR_USE_FLAVOUR_ICON</span></a> flag for documentation.
     </li>
<li class='enumerate' id='x1-49012x6'><span class='ec-lmtt-10'>Name</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Human readable entry name displayed in the OpenCore picker.
     </li>
<li class='enumerate' id='x1-49014x7'>
     <!-- l. 4633 --><p class='noindent'><span class='ec-lmtt-10'>Path</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Entry location depending on entry type.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Entries </span>specify external boot options, and therefore take device paths in the <span class='ec-lmtt-10'>Path </span>key. Care should be
         exercised as these values are not checked. Example: <span class='ec-lmtt-10'>PciRoot(0x0)/Pci(0x1,0x1)/.../\EFI\COOL.EFI</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Tools </span>specify internal boot options, which are part of the bootloader vault, and therefore take file paths
         relative to the <span class='ec-lmtt-10'>OC/Tools </span>directory. Example: <span class='ec-lmtt-10'>OpenShell.efi</span>.</li></ul>
     </li>
<li class='enumerate' id='x1-49016x8'>
     <!-- l. 4649 --><p class='noindent'><span class='ec-lmtt-10'>RealPath</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Pass full path to the tool when launching.
     </p><!-- l. 4654 --><p class='noindent'>This should typically be disabled as passing the tool directory may be unsafe with tools that accidentally attempt to
     access files without checking their integrity. Reasons to enable this property may include cases where tools cannot work
     without external files or may need them for enhanced functionality such as <span class='ec-lmtt-10'>memtest86 </span>(for logging and configuration), or
     <span class='ec-lmtt-10'>Shell </span>(for automatic script execution).
     </p><!-- l. 4661 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This property is only valid for <span class='ec-lmtt-10'>Tools </span>and cannot be specified for <span class='ec-lmtt-10'>Entries </span>(is always <span class='ec-lmtt-10'>true</span>).
     </p></li>
<li class='enumerate' id='x1-49018x9'>
     <!-- l. 4665 --><p class='noindent'><span class='ec-lmtt-10'>TextMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Run the entry in text mode instead of graphics mode.
     </p><!-- l. 4670 --><p class='noindent'>This setting may be beneficial for some older tools that require text output as all the tools are launched in graphics mode
     by default. Refer to the <a href='#output-properties'>Output Properties</a> section below for information on text modes.
</p>
     </li></ol>
<!-- l. 4676 --><p class='noindent'>
</p>
                                                                                                  
                                                                                                  
<h3 class='sectionHead' id='nvram'><span class='titlemark'>9   </span> <a id='x1-500009'></a>NVRAM</h3>
<!-- l. 4678 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction6'><span class='titlemark'>9.1   </span> <a id='x1-510009.1'></a>Introduction</h4>
<!-- l. 4680 --><p class='noindent'>This section allows setting non-volatile UEFI variables commonly described as NVRAM variables. Refer to <span class='ec-lmtt-10'>man nvram </span>for
details. The macOS operating system extensively uses NVRAM variables for OS — Bootloader — Firmware
intercommunication. Hence, the supply of several NVRAM variables is required for the proper functioning of
macOS.
</p><!-- l. 4686 --><p class='noindent'>Each NVRAM variable consists of its name, value, attributes (refer to UEFI specification), and its <a href='https://en.wikipedia.org/wiki/Universally_unique_identifier'>GUID</a>, representing which
‘section’ the NVRAM variable belongs to. The macOS operating system makes use of several GUIDs, including but not limited
to:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14 </span>(<span class='ec-lmtt-10'>APPLE_VENDOR_VARIABLE_GUID</span>)
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82 </span>(<span class='ec-lmtt-10'>APPLE_BOOT_VARIABLE_GUID</span>)
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>5EDDA193-A070-416A-85EB-2A1181F45B18 </span>(Apple Hardware Configuration Storage for <span class='ec-lmtt-10'>MacPro7,1</span>)
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>8BE4DF61-93CA-11D2-AA0D-00E098032B8C </span>(<span class='ec-lmtt-10'>EFI_GLOBAL_VARIABLE_GUID</span>)
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102 </span>(<span class='ec-lmtt-10'>OC_VENDOR_VARIABLE_GUID</span>)</li></ul>
<!-- l. 4711 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Some of the variables may be added by the <a href='#platformnvram-properties'>PlatformNVRAM</a> or <a href='#generic-properties'>Generic</a> subsections of the <a href='#platforminfo'>PlatformInfo</a> section. Please
ensure that variables set in this section do not conflict with items in those subsections as the implementation behaviour is
undefined otherwise.
</p><!-- l. 4718 --><p class='noindent'>The <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol implementation, currently offered as a part of the <span class='ec-lmtt-10'>OpenRuntime </span>driver, is often required
for macOS to function properly. While this brings many benefits, there are some limitations that should be considered for
certain use cases.
</p><!-- l. 4723 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-51002x1'>Not all tools may be aware of protected namespaces.<br class='newline' />When <span class='ec-lmtt-10'>RequestBootVarRouting </span>is used, <span class='ec-lmtt-10'>Boot</span>-prefixed variable access is restricted and protected in a separate
     namespace. To access the original variables, tools must be aware of the <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>logic.</li></ol>
<!-- l. 4730 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties5'><span class='titlemark'>9.2   </span> <a id='x1-520009.2'></a>Properties</h4>
<!-- l. 4732 --><p class='noindent'>
                                                                                                  
                                                                                                  
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-52002x1'>
     <!-- l. 4734 --><p class='noindent'><span class='ec-lmtt-10'>Add</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets NVRAM variables from a map (<span class='ec-lmtt-10'>plist dict</span>) of GUIDs to a map (<span class='ec-lmtt-10'>plist dict</span>) of variable
     names and their values in <span class='ec-lmtt-10'>plist multidata </span>format. GUIDs must be provided in canonic string format in upper
     or lower case (e.g. <span class='ec-lmtt-10'>8BE4DF61-93CA-11D2-AA0D-00E098032B8C</span>).
     </p><!-- l. 4741 --><p class='noindent'>The <span class='ec-lmtt-10'>EFI_VARIABLE_BOOTSERVICE_ACCESS </span>and <span class='ec-lmtt-10'>EFI_VARIABLE_RUNTIME_ACCESS </span>attributes of created variables
     are set. Variables will only be set if not present or deleted. That is, to overwrite an existing variable value, add
     the variable name to the <span class='ec-lmtt-10'>Delete </span>section. This approach enables the provision of default values until the operating
     system takes the lead.
     </p><!-- l. 4746 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The implementation behaviour is undefined when the <span class='ec-lmtt-10'>plist key </span>does not conform to the GUID format.
     </p></li>
<li class='enumerate' id='x1-52004x2'><span class='ec-lmtt-10'>Delete</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Removes NVRAM variables from a map (<span class='ec-lmtt-10'>plist dict</span>) of GUIDs to an array (<span class='ec-lmtt-10'>plist array</span>) of
     variable names in <span class='ec-lmtt-10'>plist string </span>format.
     </li>
<li class='enumerate' id='x1-52006x3'>
     <!-- l. 4757 --><p class='noindent'><span class='ec-lmtt-10'>LegacyEnable</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enables loading a NVRAM variable file named <span class='ec-lmtt-10'>nvram.plist </span>from EFI volume root.
     </p><!-- l. 4763 --><p class='noindent'>This file must have a root <span class='ec-lmtt-10'>plist dictionary </span>type and contain two fields: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Version </span>— <span class='ec-lmtt-10'>plist integer</span>, file version, must be set to 1.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Add </span>— <span class='ec-lmtt-10'>plist dictionary</span>, equivalent to <span class='ec-lmtt-10'>Add </span>from <span class='ec-lmtt-10'>config.plist</span>.</li></ul>
     <!-- l. 4771 --><p class='noindent'>Variable loading happens prior to the <span class='ec-lmtt-10'>Delete </span>(and <span class='ec-lmtt-10'>Add</span>) phases. Unless <span class='ec-lmtt-10'>LegacyOverwrite </span>is enabled, it will not overwrite
     any existing variable. Variables allowed to be set must be specified in <span class='ec-lmtt-10'>LegacySchema</span>.
     </p><!-- l. 4775 --><p class='noindent'>Third-party scripts may be used to create <span class='ec-lmtt-10'>nvram.plist </span>file. An example of such script can be found in
     <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/LogoutHook'><span class='ec-lmtt-10'>Utilities/LogoutHook</span></a>. The use of third-party scripts may require <span class='ec-lmtt-10'>ExposeSensitiveData </span>set to <span class='ec-lmtt-10'>0x3 </span>to provide
     <span class='ec-lmtt-10'>boot-path </span>variable with the OpenCore EFI partition UUID.
     </p><!-- l. 4781 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: This feature can be dangerous, as it passes unprotected data to firmware variable services. Only use when no
     hardware NVRAM implementation is provided by the firmware or when the NVRAM implementation is
     incompatible.
     </p></li>
<li class='enumerate' id='x1-52008x4'>
     <!-- l. 4786 --><p class='noindent'><span class='ec-lmtt-10'>LegacyOverwrite</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Permits overwriting firmware variables from <span class='ec-lmtt-10'>nvram.plist</span>.
     </p><!-- l. 4791 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Only variables accessible from the operating system will be overwritten.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-52010x5'>
     <!-- l. 4794 --><p class='noindent'><span class='ec-lmtt-10'>LegacySchema</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Allows setting certain NVRAM variables from a map (<span class='ec-lmtt-10'>plist dict</span>) of GUIDs to an array (<span class='ec-lmtt-10'>plist array</span>)
     of variable names in <span class='ec-lmtt-10'>plist string </span>format.
     </p><!-- l. 4800 --><p class='noindent'><span class='ec-lmtt-10'>* </span>value can be used to accept all variables for certain GUID.
     </p><!-- l. 4802 --><p class='noindent'><span class='ec-lmbx-10'>WARNING</span>: Choose variables carefully, as the nvram.plist file is not vaulted. For instance, do not include <span class='ec-lmtt-10'>boot-args </span>or
     <span class='ec-lmtt-10'>csr-active-config</span>, as these can be used to bypass SIP.
     </p></li>
<li class='enumerate' id='x1-52012x6'>
     <!-- l. 4807 --><p class='noindent'><span class='ec-lmtt-10'>WriteFlash</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enables writing to flash memory for all added variables.
     </p><!-- l. 4812 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This value should be enabled on most types of firmware but is left configurable to account for firmware that may
     have issues with NVRAM variable storage garbage collection or similar.
</p>
     </li></ol>
<!-- l. 4818 --><p class='noindent'>The <span class='ec-lmtt-10'>nvram </span>command can be used to read NVRAM variable values from macOS by concatenating the GUID and name
variables separated by a <span class='ec-lmtt-10'>: </span>symbol. For example, <span class='ec-lmtt-10'>nvram 7C436110-AB2A-4BBB-A880-FE41995C9F82:boot-args</span>.
</p><!-- l. 4822 --><p class='noindent'>A continuously updated variable list can be found in a corresponding document: <a href='https://docs.google.com/spreadsheets/d/1HTCBwfOBkXsHiK7os3b2CUc6k68axdJYdGl-TyXqLu0'>NVRAM Variables</a>.
</p><!-- l. 4825 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='mandatory-variables'><span class='titlemark'>9.3   </span> <a id='x1-530009.3'></a>Mandatory Variables</h4>
<!-- l. 4827 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: These variables may be added by the <a href='#platformnvram-properties'>PlatformNVRAM</a> or <a href='#generic-properties'>Generic</a> subsections of the <a href='#platforminfo'>PlatformInfo</a> section. Using
<span class='ec-lmtt-10'>PlatformInfo </span>is the recommended way of setting these variables.
</p><!-- l. 4833 --><p class='noindent'>The following variables are mandatory for macOS functioning:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:FirmwareFeatures</span>
     32-bit <span class='ec-lmtt-10'>FirmwareFeatures</span>. Present on all Macs to avoid extra parsing of SMBIOS tables.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:FirmwareFeaturesMask</span>
     32-bit <span class='ec-lmtt-10'>FirmwareFeaturesMask</span>. Present on all Macs to avoid extra parsing of SMBIOS tables.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:MLB
     </span><span class='ec-lmtt-10'>BoardSerialNumber</span>. Present on newer Macs (2013+ at least) to avoid extra parsing of SMBIOS tables, especially
     in <span class='ec-lmtt-10'>boot.efi</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ROM</span>
     Primary network adapter MAC address or replacement value. Present on newer Macs (2013+ at least) to avoid
     accessing special memory region, especially in <span class='ec-lmtt-10'>boot.efi</span>.</li></ul>
<!-- l. 4858 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='recommended-variables'><span class='titlemark'>9.4   </span> <a id='x1-540009.4'></a>Recommended Variables</h4>
<!-- l. 4860 --><p class='noindent'>The following variables are recommended for faster startup or other improvements:
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:BridgeOSHardwareModel</span>
     Bridge OS hardware model variable used to propagate to IODT bridge-model by <span class='ec-lmtt-10'>EfiBoot</span>. Read by <span class='ec-lmtt-10'>hw.target
     </span><span class='ec-lmtt-10'>sysctl</span>, used by SoftwareUpdateCoreSupport.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:csr-active-config</span>
     32-bit System Integrity Protection bitmask. Declared in XNU source code in <a href='https://opensource.apple.com/source/xnu/xnu-4570.71.2/bsd/sys/csr.h.auto.html'>csr.h</a>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ExtendedFirmwareFeatures</span>
     Combined <span class='ec-lmtt-10'>FirmwareFeatures </span>and <span class='ec-lmtt-10'>ExtendedFirmwareFeatures</span>. Present on newer Macs to avoid extra parsing
     of SMBIOS tables.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ExtendedFirmwareFeaturesMask</span>
     Combined <span class='ec-lmtt-10'>FirmwareFeaturesMask </span>and <span class='ec-lmtt-10'>ExtendedFirmwareFeaturesMask</span>. Present on newer Macs to avoid extra
     parsing of SMBIOS tables.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_BID</span>
     Hardware <span class='ec-lmtt-10'>BoardProduct </span>(e.g. <span class='ec-lmtt-10'>Mac-35C1E88140C3E6CF</span>). Not present on real Macs, but used to avoid extra
     parsing of SMBIOS tables, especially in <span class='ec-lmtt-10'>boot.efi</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_MLB</span>
     Hardware <span class='ec-lmtt-10'>BoardSerialNumber</span>. Override for MLB. Present on newer Macs (2013+ at least).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_ROM</span>
     Hardware ROM. Override for ROM. Present on newer Macs (2013+ at least).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:SSN</span>
     Serial number. Present on newer Macs (2013+ at least).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:prev-lang:kbd</span>
     ASCII string defining default keyboard layout. Format is <span class='ec-lmtt-10'>lang-COUNTRY:keyboard</span>, e.g. <span class='ec-lmtt-10'>ru-RU:252 </span>for Russian
     locale and ABC keyboard. Also accepts short forms: <span class='ec-lmtt-10'>ru:252 </span>or <span class='ec-lmtt-10'>ru:0 </span>(U.S. keyboard, compatible with 10.9). Full
     decoded keyboard list from <span class='ec-lmtt-10'>AppleKeyboardLayouts-L.dat </span>can be found <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/AppleKeyboardLayouts'>here</a>. Using non-latin keyboard on 10.14
     will not enable ABC keyboard, unlike previous and subsequent macOS versions, and is thus not recommended
     in case 10.14 is needed.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:security-mode</span>
     ASCII  string  defining  FireWire  security  mode.  Legacy,  can  be  found  in  IOFireWireFamily  source  code  in
     <a href='https://opensource.apple.com/source/IOFireWireFamily/IOFireWireFamily-473/IOFireWireFamily.kmodproj/IOFireWireController.cpp.auto.html'>IOFireWireController.cpp</a>. It is recommended not to set this variable, which may speedup system startup. Setting
     to <span class='ec-lmtt-10'>full </span>is equivalent to not setting the variable and <span class='ec-lmtt-10'>none </span>disables FireWire security.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:UIScale</span>
     One-byte data defining <span class='ec-lmtt-10'>boot.efi </span>user interface scaling. Should be <span class='ec-lmbx-10'>01 </span>for normal screens and <span class='ec-lmbx-10'>02 </span>for HiDPI
     screens.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:ForceDisplayRotationInEFI</span>
     32-bit integer defining display rotation. Can be <span class='ec-lmbx-10'>0 </span>for no rotation or any of <span class='ec-lmtt-10'>90</span>, <span class='ec-lmtt-10'>180</span>, <span class='ec-lmtt-10'>270 </span>for matching rotation in
     degrees.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:DefaultBackgroundColor</span>
     Four-byte <span class='ec-lmtt-10'>BGRA </span>data defining <span class='ec-lmtt-10'>boot.efi </span>user interface background colour. Standard colours include <span class='ec-lmbx-10'>BF BF BF
     </span><span class='ec-lmbx-10'>00 </span>(Light Gray) and <span class='ec-lmbx-10'>00 00 00 00 </span>(Syrah Black). Other colours may be set at user’s preference.</li></ul>
<!-- l. 4939 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='other-variables'><span class='titlemark'>9.5   </span> <a id='x1-550009.5'></a>Other Variables</h4>
<!-- l. 4941 --><p class='noindent'>The following variables may be useful for certain configurations or troubleshooting:
</p>
     <ul class='itemize1'>
     <li class='itemize'>
     <!-- l. 4947 --><p class='noindent'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:boot-args</span>
     Kernel arguments, used to pass configuration to Apple kernel and drivers. There are many arguments, which
     may be found by looking for the use of <span class='ec-lmtt-10'>PE_parse_boot_argn </span>function in the kernel or driver code. Some of the
     known boot arguments include:
</p>
         <ul class='itemize2'>
         <li class='itemize'><span class='ec-lmtt-10'>acpi_layer=0xFFFFFFFF</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>acpi_level=0xFFFF5F </span>(implies <a href='https://github.com/acpica/acpica/blob/master/source/include/acoutput.h'><span class='ec-lmtt-10'>ACPI_ALL_COMPONENTS</span></a>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>arch=i386 </span>(force kernel architecture to <span class='ec-lmtt-10'>i386</span>, see <span class='ec-lmtt-10'>KernelArch</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>batman=VALUE </span>(<span class='ec-lmtt-10'>AppleSmartBatteryManager </span>debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>batman-nosmc=1 </span>(disable <span class='ec-lmtt-10'>AppleSmartBatteryManager </span>SMC interface)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>cpus=VALUE </span>(maximum number of CPUs used)
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>debug=VALUE </span>(debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>io=VALUE </span>(<span class='ec-lmtt-10'>IOKit </span>debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ioaccel_debug=VALUE </span>(<span class='ec-lmtt-10'>IOAccelerator </span>debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>keepsyms=1 </span>(show panic log debug symbols)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>kextlog=VALUE </span>(kernel extension loading debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>nvram-log=1 </span>(enables AppleEFINVRAM logs)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>nv_disable=1 </span>(disables NVIDIA GPU acceleration)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>nvda_drv=1 </span>(legacy way to enable NVIDIA web driver, removed in 10.12)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>npci=0x2000 </span>(<a href='https://www.insanelymac.com/forum/topic/260539-1068-officially-released/?do=findComment&amp;comment=1707972'>legacy</a>, disables <span class='ec-lmtt-10'>kIOPCIConfiguratorPFM64</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>lapic_dont_panic=1 </span>(disable lapic spurious interrupt panic on AP cores)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>panic_on_display_hang=1 </span>(trigger panic on display hang)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>panic_on_gpu_hang=1 </span>(trigger panic on GPU hang)
         </li>
         <li class='itemize'>
         <!-- l. 4975 --><p class='noindent'><span class='ec-lmtt-10'>serial=VALUE </span>(configure serial logging mode) — The following bits are used by XNU: </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>(<span class='ec-lmtt-10'>SERIALMODE_OUTPUT</span>, bit <span class='ec-lmtt-10'>0</span>) — Enable serial output.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>(<span class='ec-lmtt-10'>SERIALMODE_INPUT</span>, bit <span class='ec-lmtt-10'>1</span>) — Enable serial input.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>(<span class='ec-lmtt-10'>SERIALMODE_SYNCDRAIN</span>, bit <span class='ec-lmtt-10'>2</span>) — Enable serial drain synchronisation.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>0x08 </span>(<span class='ec-lmtt-10'>SERIALMODE_BASE_TTY</span>, bit <span class='ec-lmtt-10'>3</span>) — Load Base/Recovery/FVUnlock TTY.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>0x10 </span>(<span class='ec-lmtt-10'>SERIALMODE_NO_IOLOG</span>, bit <span class='ec-lmtt-10'>4</span>) — Prevent IOLogs writing to serial.</li></ul>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>slide=VALUE </span>(manually set KASLR slide)
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>smcdebug=VALUE </span>(<span class='ec-lmtt-10'>AppleSMC </span>debug mask)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>spin_wait_for_gpu=1 </span>(reduces GPU timeout on high load)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-amd_no_dgpu_accel </span>(alternative to <a href='https://github.com/acidanthera/WhateverGreen'>WhateverGreen</a>’s <span class='ec-lmtt-10'>-radvesa </span>for new GPUs)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-nehalem_error_disable </span>(disables the AppleTyMCEDriver)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-no_compat_check </span>(disable model checking on 10.7+)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-s </span>(single mode)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-v </span>(verbose mode)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-x </span>(safe mode)</li></ul>
     <!-- l. 4995 --><p class='noindent'>There are multiple external places summarising macOS argument lists: <a href='https://osxeon.wordpress.com/2015/08/10/boot-argument-options-in-os-x'>example 1</a>, <a href='https://superuser.com/questions/255176/is-there-a-list-of-available-boot-args-for-darwin-os-x'>example 2</a>.
     </p></li>
     <li class='itemize'>
     <!-- l. 5000 --><p class='noindent'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:bootercfg</span>
     Booter arguments, similar to <span class='ec-lmtt-10'>boot-args </span>but for <span class='ec-lmtt-10'>boot.efi</span>. Accepts a set of arguments, which are hexadecimal 64-bit
     values with or without <span class='ec-lmtt-10'>0x</span>. At different stages <span class='ec-lmtt-10'>boot.efi </span>will request different debugging (logging) modes (e.g. after
     <span class='ec-lmtt-10'>ExitBootServices </span>it will only print to serial). Several booter arguments control whether these requests will succeed. The
     list of known requests is covered below:
</p>
         <ul class='itemize2'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00 </span>– <span class='ec-lmtt-10'>INIT</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>– <span class='ec-lmtt-10'>VERBOSE </span>(e.g. <span class='ec-lmtt-10'>-v</span>, force console logging).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>– <span class='ec-lmtt-10'>EXIT</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x03 </span>– <span class='ec-lmtt-10'>RESET:OK</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>– <span class='ec-lmtt-10'>RESET:FAIL </span>(e.g. unknown <span class='ec-lmtt-10'>board-id</span>, hibernate mismatch, panic loop, etc.).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x05 </span>– <span class='ec-lmtt-10'>RESET:RECOVERY</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x06 </span>– <span class='ec-lmtt-10'>RECOVERY</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x07 </span>– <span class='ec-lmtt-10'>REAN:START</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x08 </span>– <span class='ec-lmtt-10'>REAN:END</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x09 </span>– <span class='ec-lmtt-10'>DT </span>(can no longer log to DeviceTree).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0A </span>– <span class='ec-lmtt-10'>EXITBS:START </span>(forced serial only).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0B </span>– <span class='ec-lmtt-10'>EXITBS:END </span>(forced serial only).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0C </span>– <span class='ec-lmtt-10'>UNKNOWN</span>.</li></ul>
     <!-- l. 5026 --><p class='noindent'>In 10.15, debugging support was defective up to the 10.15.4 release due to refactoring issues as well as the introduction of
     a <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/Protocol/AppleDebugLog.h'>new debug protocol</a>. Some of the arguments and their values below may not be valid for versions prior to 10.15.4. The
     list of known arguments is covered below:
</p>
         <ul class='itemize2'>
         <li class='itemize'>
         <!-- l. 5033 --><p class='noindent'><span class='ec-lmtt-10'>boot-save-log=VALUE </span>— debug log save mode for normal boot. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0</span>
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1</span>
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>3</span>
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>4 </span>— (save to file).</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5041 --><p class='noindent'><span class='ec-lmtt-10'>wake-save-log=VALUE </span>— debug log save mode for hibernation wake. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disabled.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1</span>
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>3 </span>— (unavailable).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>4 </span>— (save to file, unavailable).</li></ul>
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'>
         <!-- l. 5049 --><p class='noindent'><span class='ec-lmtt-10'>breakpoint=VALUE </span>— enables debug breaks (missing in production <span class='ec-lmtt-10'>boot.efi</span>). </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disables debug breaks on errors (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables debug breaks on errors.</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5054 --><p class='noindent'><span class='ec-lmtt-10'>console=VALUE </span>— enables console logging. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disables console logging.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables console logging when debug protocol is missing (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— enables console logging unconditionally (unavailable).</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5060 --><p class='noindent'><span class='ec-lmtt-10'>embed-log-dt=VALUE </span>— enables DeviceTree logging. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disables DeviceTree logging (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables DeviceTree logging.</li></ul>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>kc-read-size=VALUE </span>— Chunk size used for buffered I/O from network or disk for prelinkedkernel reading and
         related. Set to 1MB (0x100000) by default, can be tuned for faster booting.
         </li>
         <li class='itemize'>
         <!-- l. 5068 --><p class='noindent'><span class='ec-lmtt-10'>log-level=VALUE </span>— log level bitmask. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— enables trace logging (default).</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5072 --><p class='noindent'><span class='ec-lmtt-10'>serial=VALUE </span>— enables serial logging. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disables serial logging (default).
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables serial logging for <span class='ec-lmtt-10'>EXITBS:END </span>onwards.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— enables serial logging for <span class='ec-lmtt-10'>EXITBS:START </span>onwards.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>3 </span>— enables serial logging when debug protocol is missing.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>4 </span>— enables serial logging unconditionally.</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5080 --><p class='noindent'><span class='ec-lmtt-10'>timestamps=VALUE </span>— enables timestamp logging. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>0 </span>— disables timestamp logging.
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables timestamp logging (default).</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5085 --><p class='noindent'><span class='ec-lmtt-10'>log=VALUE </span>— deprecated starting from 10.15. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— AppleLoggingConOutOrErrSet/AppleLoggingConOutOrErrPrint (classical ConOut/StdErr)
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— AppleLoggingStdErrSet/AppleLoggingStdErrPrint (StdErr or serial?)
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>4  </span>—   AppleLoggingFileSet/AppleLoggingFilePrint   (BOOTER.LOG/BOOTER.OLD   file   on   EFI
             partition)</li></ul>
         </li>
         <li class='itemize'>
         <!-- l. 5093 --><p class='noindent'><span class='ec-lmtt-10'>debug=VALUE </span>— deprecated starting from 10.15. </p>
             <ul class='itemize3'>
             <li class='itemize'><span class='ec-lmtt-10'>1 </span>— enables print something to BOOTER.LOG (stripped code implies there may be a crash)
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>2 </span>— enables perf logging to /efi/debug-log in the device three
             </li>
             <li class='itemize'><span class='ec-lmtt-10'>4 </span>— enables timestamp printing for styled printf calls</li></ul>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>level=VALUE </span>— deprecated starting from 10.15. Verbosity level of DEBUG output. Everything but <span class='ec-lmtt-10'>0x80000000 </span>is
         stripped from the binary, and this is the default value.</li></ul>
     <!-- l. 5105 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Enable the <span class='ec-lmtt-10'>AppleDebug </span>option to display verbose output from <span class='ec-lmtt-10'>boot.efi </span>on modern macOS versions. This will save
     the log to the general OpenCore log file. For versions before 10.15.4, set <span class='ec-lmtt-10'>bootercfg </span>to <span class='ec-lmtt-10'>log=1</span>. This will print verbose
     output onscreen.
     </p></li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:bootercfg-once</span>
     Booter arguments override removed after first launch. Otherwise equivalent to <span class='ec-lmtt-10'>bootercfg</span>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:csr-data</span>
     Specify sources of kexts which will be approved regardless of SIP <span class='ec-lmtt-10'>CSR_ALLOW_UNAPPROVED_KEXTS </span>value.<br class='newline' />Example contents:<br class='newline' /><span class='ec-lmtt-10'>&lt;dict&gt;&lt;key&gt;kext-allowed-teams&lt;/key&gt;&lt;array&gt;&lt;string&gt;{DEVELOPER-TEAM-ID}&lt;/string&gt;&lt;/array&gt;&lt;/dict&gt;%00</span>
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:efiboot-perf-record</span>
     Enable performance log saving in <span class='ec-lmtt-10'>boot.efi</span>. Performance log is saved to physical memory and is pointed to by the
     <span class='ec-lmtt-10'>efiboot-perf-record-data </span>and <span class='ec-lmtt-10'>efiboot-perf-record-size </span>variables. Starting from 10.15.4, it can also be saved to
                                                                                                  
                                                                                                  
     the OpenCore log by setting the <span class='ec-lmtt-10'>AppleDebug </span>option.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:fmm-computer-name</span>
     Current saved host name. ASCII string.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:nvda_drv</span>
     NVIDIA Web Driver control variable. Takes ASCII digit <span class='ec-lmtt-10'>1 </span>or <span class='ec-lmtt-10'>0 </span>to enable or disable installed driver.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:run-efi-updater</span>
     Override EFI firmware updating support in macOS (MultiUpdater, ThorUtil, and so on). Setting this to <span class='ec-lmtt-10'>No </span>or
     alternative boolean-castable value will prevent any firmware updates in macOS starting with 10.10 at
     least.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:StartupMute</span>
     Mute startup chime sound in firmware audio support. 8-bit integer. The value of <span class='ec-lmtt-10'>0x00 </span>means unmuted. Missing variable
     or any other value means muted.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:SystemAudioVolume</span>
     System audio volume level for firmware audio support. 8-bit unsigned integer. The bit of <span class='ec-lmtt-10'>0x80 </span>means muted. The
     remaining bits are used to encode the raw amplifier gain setting to be applied to the audio amplifier in use. Exactly what
     this value means depends on the codec (and potentially on the specific amplifier within the codec). This value is capped
     by macOS to the <span class='ec-lmtt-10'>MaximumBootBeepVolume </span>AppleHDA layout value, to avoid over-loud audio playback in the
     firmware.
     </li>
     <li class='itemize'>
     <!-- l. 5155 --><p class='noindent'><span class='ec-lmtt-10'>7C436110-AB2A-4BBB-A880-FE41995C9F82:SystemAudioVolumeDB</span>
     Current system audio volume level in decibels (dB). 8-bit signed integer. The value represents the audio offset (gain if
     positive, attenuation if negative) in dB relative to the amplifier reference value of 0 dB. Exactly which volume level is
     represented by 0 dB depends on the codec (and potentially on the specific amplifier within the codec) but it is normally
     at or near the maximum available amplifier volume. Typical values of this variable range from approximately -60 (the
     exact value depends on the audio hardware) up to exactly 0. On non-typical audio hardware, the value may go above
     zero.
     </p><!-- l. 5167 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Unlike <span class='ec-lmtt-10'>SystemAudioVolume</span>, this value is not capped.
     </p></li>
     <li class='itemize'>
     <!-- l. 5169 --><p class='noindent'><span class='ec-lmtt-10'>5EDDA193-A070-416A-85EB-2A1181F45B18:PEXConf</span>
     PCI expansion slot configuration for <span class='ec-lmtt-10'>MacPro7,1</span>. 8-byte sequence describing default PCI slot configuration. Each byte
     refers to a configuration for a dedicated PCI slot.
</p>
         <ul class='itemize2'>
         <li class='itemize'>Slot 1 resides at <span class='ec-lmtt-10'>IOService:/AppleACPIPlatformExpert/PC01@0/AppleACPIPCI/BR1A@0 </span>and its path is
         hardcoded. This slot is not behind a muxer.
         </li>
         <li class='itemize'>Slot 3 resides at <span class='ec-lmtt-10'>IOService:/AppleACPIPlatformExpert/PC03@0/AppleACPIPCI/BR3A@0 </span>and its path is
         hardcoded. This slot is not behind a muxer.
         </li>
         <li class='itemize'>Slots 2, 4-8 are dynamic and are matched based on <span class='ec-lmtt-10'>AAPL,slot-name </span>property with <span class='ec-lmtt-10'>Slot-N </span>value, where <span class='ec-lmtt-10'>N</span>
         is the slot number. All these slots are behind the muxer.</li></ul>
                                                                                                  
                                                                                                  
     <!-- l. 5186 --><p class='noindent'>Refer to the <a href='https://support.apple.com/HT210104'>support page</a> for more details on how <span class='ec-lmtt-10'>MacPro7,1 </span>slots are configured.
     </p></li>
     <li class='itemize'><span class='ec-lmtt-10'>5EDDA193-A070-416A-85EB-2A1181F45B18:SlotUtilPEXConf</span>
     User PCI expansion slot configuration for <span class='ec-lmtt-10'>MacPro7,1</span>. 8-byte sequence describing user PCI slot configuration.
</li></ul>
<!-- l. 5197 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='platforminfo'><span class='titlemark'>10   </span> <a id='x1-5600010'></a>PlatformInfo</h3>
<!-- l. 5199 --><p class='noindent'>Platform information consists of several identification fields generated or filled manually to be compatible with macOS services.
The base part of the configuration may be obtained from <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/AppleModels'><span class='ec-lmtt-10'>AppleModels</span></a>, which itself generates a set of interfaces based on a
database in <a href='https://yaml.org/spec/1.2/spec.html'>YAML</a> format. These fields are written to three destinations:
</p>
     <ul class='itemize1'>
     <li class='itemize'><a href='https://www.dmtf.org/standards/smbios'>SMBIOS</a>
     </li>
     <li class='itemize'><a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Intel/Protocol/DataHub.h'>Data Hub</a>
     </li>
     <li class='itemize'>NVRAM</li></ul>
<!-- l. 5218 --><p class='noindent'>Most of the fields specify the overrides in SMBIOS, and their field names conform to EDK2 <a href='https://github.com/acidanthera/audk/blob/master/MdePkg/Include/IndustryStandard/SmBios.h'>SmBios.h</a> header file. However,
several important fields reside in Data Hub and NVRAM. Some of the values can be found in more than one field and/or
destination, so there are two ways to control their update process: manual, where all the values are specified (the
default), and semi-automatic, where (<span class='ec-lmtt-10'>Automatic</span>) only certain values are specified, and later used for system
configuration.
</p><!-- l. 5228 --><p class='noindent'>The <a href='http://www.nongnu.org/dmidecode'>dmidecode</a> utility can be used to inspect SMBIOS contents and a version with macOS specific enhancements can be
downloaded from <a href='https://github.com/acidanthera/dmidecode/releases'>Acidanthera/dmidecode</a>.
</p><!-- l. 5232 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties6'><span class='titlemark'>10.1   </span> <a id='x1-5700010.1'></a>Properties</h4>
<!-- l. 5234 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-57002x1'>
     <!-- l. 5236 --><p class='noindent'><span class='ec-lmtt-10'>Automatic</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Generate PlatformInfo based on the <span class='ec-lmtt-10'>Generic </span>section instead of using values from the <span class='ec-lmtt-10'>DataHub</span>,
     <span class='ec-lmtt-10'>NVRAM</span>, and <span class='ec-lmtt-10'>SMBIOS </span>sections.
     </p><!-- l. 5243 --><p class='noindent'>Enabling this option is useful when <span class='ec-lmtt-10'>Generic </span>section is flexible enough: </p>
                                                                                                  
                                                                                                  
         <ul class='itemize1'>
         <li class='itemize'>When enabled <span class='ec-lmtt-10'>SMBIOS</span>, <span class='ec-lmtt-10'>DataHub</span>, and <span class='ec-lmtt-10'>PlatformNVRAM </span>data is unused.
         </li>
         <li class='itemize'>When disabled <span class='ec-lmtt-10'>Generic </span>section is unused.</li></ul>
     <!-- l. 5252 --><p class='noindent'><span class='ec-lmbx-10'>Warning</span>: Setting this option to <span class='ec-lmtt-10'>false </span>is strongly discouraged when intending to update platform information. A <span class='ec-lmtt-10'>false</span>
     setting is typically only valid for minor corrections to SMBIOS values on legacy Apple hardware. In all other
     cases, setting <span class='ec-lmtt-10'>Automatic </span>to <span class='ec-lmtt-10'>false </span>may lead to hard-to-debug errors resulting from inconsistent or invalid
     settings.
     </p></li>
<li class='enumerate' id='x1-57004x2'><span class='ec-lmtt-10'>CustomMemory</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Use custom memory configuration defined in the <span class='ec-lmtt-10'>Memory </span>section. This completely replaces any existing
     memory configuration in SMBIOS, and is only active when <span class='ec-lmtt-10'>UpdateSMBIOS </span>is set to <span class='ec-lmtt-10'>true</span>.
     </li>
<li class='enumerate' id='x1-57006x3'>
     <!-- l. 5268 --><p class='noindent'><span class='ec-lmtt-10'>UpdateDataHub</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update Data Hub fields. These fields are read from the <span class='ec-lmtt-10'>Generic </span>or <span class='ec-lmtt-10'>DataHub </span>sections depending on the
     setting of the <span class='ec-lmtt-10'>Automatic </span>property.
     </p><!-- l. 5275 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The implementation of the Data Hub protocol in EFI firmware on virtually all systems, including Apple hardware,
     means that existing Data Hub entries cannot be overridden. New entries are added to the end of the Data
     Hub instead, with macOS ignoring old entries. This can be worked around by replacing the Data Hub
     protocol using the <span class='ec-lmtt-10'>ProtocolOverrides </span>section. Refer to the <span class='ec-lmtt-10'>DataHub </span>protocol override description for
     details.
     </p></li>
<li class='enumerate' id='x1-57008x4'>
     <!-- l. 5282 --><p class='noindent'><span class='ec-lmtt-10'>UpdateNVRAM</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update NVRAM fields related to platform information.
     </p><!-- l. 5287 --><p class='noindent'>These fields are read from the <span class='ec-lmtt-10'>Generic </span>or <span class='ec-lmtt-10'>PlatformNVRAM </span>sections depending on the setting of the <span class='ec-lmtt-10'>Automatic </span>property.
     All the other fields are to be specified with the <span class='ec-lmtt-10'>NVRAM </span>section.
     </p><!-- l. 5291 --><p class='noindent'>If <span class='ec-lmtt-10'>UpdateNVRAM </span>is set to <span class='ec-lmtt-10'>false</span>, the aforementioned variables can be updated with the <a href='#nvram'><span class='ec-lmtt-10'>NVRAM</span></a> section. If
     <span class='ec-lmtt-10'>UpdateNVRAM </span>is set to <span class='ec-lmtt-10'>true</span>, the behaviour is undefined when any of the fields are present in the <span class='ec-lmtt-10'>NVRAM</span>
     section.
     </p></li>
<li class='enumerate' id='x1-57010x5'><span class='ec-lmtt-10'>UpdateSMBIOS</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update SMBIOS fields. These fields are read from the <span class='ec-lmtt-10'>Generic </span>or <span class='ec-lmtt-10'>SMBIOS </span>sections depending on the
     setting of the <span class='ec-lmtt-10'>Automatic </span>property.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-57012x6'>
     <!-- l. 5303 --><p class='noindent'><span class='ec-lmtt-10'>UpdateSMBIOSMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Create</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update SMBIOS fields approach:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>TryOverwrite </span>— <span class='ec-lmtt-10'>Overwrite </span>if new size is &lt;= than the page-aligned original and there are no issues with
         legacy region unlock. <span class='ec-lmtt-10'>Create </span>otherwise. Has issues on some types of firmware.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Create </span>—  Replace  the  tables  with  newly  allocated  EfiReservedMemoryType  at  AllocateMaxAddress
         without any fallbacks.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Overwrite </span>— Overwrite existing gEfiSmbiosTableGuid and gEfiSmbiosTable3Guid data if it fits new size.
         Abort with unspecified state otherwise.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Custom </span>—  Write  SMBIOS  tables  (<span class='ec-lmtt-10'>gEfiSmbios(3)TableGuid</span>)  to  <span class='ec-lmtt-10'>gOcCustomSmbios(3)TableGuid </span>to
         workaround firmware overwriting SMBIOS contents at ExitBootServices. Otherwise equivalent to <span class='ec-lmtt-10'>Create</span>.
         Requires patching AppleSmbios.kext and AppleACPIPlatform.kext to read from another GUID: <span class='ec-lmtt-10'>"EB9D2D31"</span>
         - <span class='ec-lmtt-10'>"EB9D2D35" </span>(in ASCII), done automatically by <span class='ec-lmtt-10'>CustomSMBIOSGuid </span>quirk.</li></ul>
     <!-- l. 5331 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: A side effect of using the <span class='ec-lmtt-10'>Custom </span>approach that it makes SMBIOS updates exclusive to macOS, avoiding a collision
     with existing Windows activation and custom OEM software but potentially obstructing the operation of Apple-specific
     tools.
     </p></li>
<li class='enumerate' id='x1-57014x7'>
     <!-- l. 5336 --><p class='noindent'><span class='ec-lmtt-10'>UseRawUuidEncoding</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Use raw encoding for SMBIOS UUIDs.
     </p><!-- l. 5341 --><p class='noindent'>Each UUID <span class='ec-lmtt-10'>AABBCCDD-EEFF-GGHH-IIJJ-KKLLMMNNOOPP </span>is essentially a hexadecimal 16-byte number. It can be encoded in
     two ways:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Big Endian </span>— by writing all the bytes as they are without making any order changes (<span class='ec-lmtt-10'>{AA BB CC DD EE FF
         </span><span class='ec-lmtt-10'>GG HH II JJ KK LL MM NN OO PP}</span>). This method is also known as <a href='https://tools.ietf.org/html/rfc4122'>RFC 4122</a> encoding or <span class='ec-lmtt-10'>Raw </span>encoding.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Little Endian </span>— by interpreting the bytes as numbers and using Little Endian byte representation (<span class='ec-lmtt-10'>{DD
         </span><span class='ec-lmtt-10'>CC BB AA FF EE HH GG II JJ KK LL MM NN OO PP}</span>).</li></ul>
     <!-- l. 5356 --><p class='noindent'>The SMBIOS specification did not explicitly specify the encoding format for the UUID up to SMBIOS 2.6, where it
     stated that <span class='ec-lmtt-10'>Little Endian </span>encoding shall be used. This led to the confusion in both firmware implementations and
     system software as different vendors used different encodings prior to that.
                                                                                                  
                                                                                                  
</p>
         <ul class='itemize1'>
         <li class='itemize'>Apple uses the <span class='ec-lmtt-10'>Big Endian </span>format everywhere but it ignores SMBIOS UUID within macOS.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>dmidecode </span>uses the <span class='ec-lmtt-10'>Big Endian </span>format for SMBIOS 2.5.x or lower and the <span class='ec-lmtt-10'>Little Endian </span>format for 2.6
         and newer. Acidanthera <a href='https://github.com/acidanthera/dmidecode'>dmidecode</a> prints all three.
         </li>
         <li class='itemize'>Windows uses the <span class='ec-lmtt-10'>Little Endian </span>format everywhere, but this only affects the visual representation of the
         values.</li></ul>
     <!-- l. 5371 --><p class='noindent'>OpenCore always sets a recent SMBIOS version (currently 3.2) when generating the modified DMI tables. If
     <span class='ec-lmtt-10'>UseRawUuidEncoding </span>is enabled, the <span class='ec-lmtt-10'>Big Endian </span>format is used to store the <span class='ec-lmtt-10'>SystemUUID </span>data. Otherwise, the <span class='ec-lmtt-10'>Little
     </span><span class='ec-lmtt-10'>Endian </span>format is used.
     </p><!-- l. 5376 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This preference does not affect UUIDs used in DataHub and NVRAM as they are not standardised and are added
     by Apple. Unlike SMBIOS, they are always stored in the <span class='ec-lmtt-10'>Big Endian </span>format.
     </p></li>
<li class='enumerate' id='x1-57016x8'>
     <!-- l. 5381 --><p class='noindent'><span class='ec-lmtt-10'>Generic</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dictionary</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update all fields in <span class='ec-lmtt-10'>Automatic </span>mode.
     </p><!-- l. 5385 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This section is ignored but may not be removed when <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>false</span>.
     </p></li>
<li class='enumerate' id='x1-57018x9'>
     <!-- l. 5388 --><p class='noindent'><span class='ec-lmtt-10'>DataHub</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dictionary</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update Data Hub fields in non-<span class='ec-lmtt-10'>Automatic </span>mode.
     </p><!-- l. 5392 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This section is ignored and may be removed when <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>true</span>.
     </p></li>
<li class='enumerate' id='x1-57020x10'>
     <!-- l. 5395 --><p class='noindent'><span class='ec-lmtt-10'>Memory</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dictionary</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Define custom memory configuration.
     </p><!-- l. 5399 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This section is ignored and may be removed when <span class='ec-lmtt-10'>CustomMemory </span>is <span class='ec-lmtt-10'>false</span>.
     </p></li>
<li class='enumerate' id='x1-57022x11'>
     <!-- l. 5402 --><p class='noindent'><span class='ec-lmtt-10'>PlatformNVRAM</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dictionary</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update platform NVRAM fields in non-<span class='ec-lmtt-10'>Automatic </span>mode.
     </p><!-- l. 5406 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This section is ignored and may be removed when <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>true</span>.
     </p></li>
<li class='enumerate' id='x1-57024x12'>
                                                                                                  
                                                                                                  
     <!-- l. 5409 --><p class='noindent'><span class='ec-lmtt-10'>SMBIOS</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dictionary</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Update SMBIOS fields in non-<span class='ec-lmtt-10'>Automatic </span>mode.
     </p><!-- l. 5413 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This section is ignored and may be removed when <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>true</span>.</p></li></ol>
<!-- l. 5417 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='generic-properties'><span class='titlemark'>10.2   </span> <a id='x1-5800010.2'></a>Generic Properties</h4>
<!-- l. 5419 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-58002x1'>
     <!-- l. 5421 --><p class='noindent'><span class='ec-lmtt-10'>SpoofVendor</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets SMBIOS vendor fields to <span class='ec-lmtt-10'>Acidanthera</span>.
     </p><!-- l. 5426 --><p class='noindent'>It can be dangerous to use “Apple” in SMBIOS vendor fields for reasons outlined in the <span class='ec-lmtt-10'>SystemManufacturer</span>
     description. However, certain firmware may not provide valid values otherwise, which could obstruct the operation
     of some software.
     </p></li>
<li class='enumerate' id='x1-58004x2'>
     <!-- l. 5431 --><p class='noindent'><span class='ec-lmtt-10'>AdviseFeatures</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Updates <span class='ec-lmtt-10'>FirmwareFeatures </span>with supported bits.
     </p><!-- l. 5436 --><p class='noindent'>Added bits to <span class='ec-lmtt-10'>FirmwareFeatures</span>:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>FW_FEATURE_SUPPORTS_CSM_LEGACY_MODE </span>(<span class='ec-lmtt-10'>0x1</span>) - Without this bit, it is not possible to reboot to Windows
         installed on a drive with an EFI partition that is not the first partition on the disk.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>FW_FEATURE_SUPPORTS_UEFI_WINDOWS_BOOT </span>(<span class='ec-lmtt-10'>0x20000000</span>) - Without this bit, it is not possible to reboot
         to Windows installed on a drive with an EFI partition that is the first partition on the disk.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>FW_FEATURE_SUPPORTS_APFS </span>(<span class='ec-lmtt-10'>0x00080000</span>) - Without this bit, it is not possible to install macOS on an
         APFS disk.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>FW_FEATURE_SUPPORTS_LARGE_BASESYSTEM </span>(<span class='ec-lmtt-10'>0x800000000</span>) - Without this bit, it is not possible to install
         macOS versions with large BaseSystem images, such as macOS 12.</li></ul>
                                                                                                  
                                                                                                  
     <!-- l. 5452 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: On most newer firmwares these bits are already set, the option may be necessary when "upgrading" the firmware
     with new features.
     </p></li>
<li class='enumerate' id='x1-58006x3'><span class='ec-lmtt-10'>MaxBIOSVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>BIOSVersion </span>to <span class='ec-lmtt-10'>9999.999.999.999.999</span>, recommended for legacy Macs when using <span class='ec-lmtt-10'>Automatic</span>
     PlatformInfo, to avoid BIOS updates in unofficially supported macOS versions.
     </li>
<li class='enumerate' id='x1-58008x4'>
     <!-- l. 5464 --><p class='noindent'><span class='ec-lmtt-10'>SystemMemoryStatus</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Indicates whether system memory is upgradable in <span class='ec-lmtt-10'>PlatformFeature</span>. This controls the visibility of the
     Memory tab in “About This Mac”.
     </p><!-- l. 5470 --><p class='noindent'>Valid values:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Auto </span>— use the original <span class='ec-lmtt-10'>PlatformFeature </span>value.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Upgradable </span>— explicitly unset <span class='ec-lmtt-10'>PT_FEATURE_HAS_SOLDERED_SYSTEM_MEMORY </span>(<span class='ec-lmtt-10'>0x2</span>) in <span class='ec-lmtt-10'>PlatformFeature</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Soldered </span>— explicitly set <span class='ec-lmtt-10'>PT_FEATURE_HAS_SOLDERED_SYSTEM_MEMORY </span>(<span class='ec-lmtt-10'>0x2</span>) in <span class='ec-lmtt-10'>PlatformFeature</span>.</li></ul>
     <!-- l. 5481 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: On certain Mac models, such as the <span class='ec-lmtt-10'>MacBookPro10,x </span>and any <span class='ec-lmtt-10'>MacBookAir</span>, SPMemoryReporter.spreporter will
     ignore <span class='ec-lmtt-10'>PT_FEATURE_HAS_SOLDERED_SYSTEM_MEMORY </span>and assume that system memory is non-upgradable.
     </p></li>
<li class='enumerate' id='x1-58010x5'><span class='ec-lmtt-10'>ProcessorType</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Automatic)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to SMBIOS <span class='ec-lmtt-10'>ProcessorType</span>.
     </li>
<li class='enumerate' id='x1-58012x6'><span class='ec-lmtt-10'>SystemProductName</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified or not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to SMBIOS <span class='ec-lmtt-10'>SystemProductName</span>.
     </li>
<li class='enumerate' id='x1-58014x7'>
     <!-- l. 5496 --><p class='noindent'><span class='ec-lmtt-10'>SystemSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified or not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to SMBIOS <span class='ec-lmtt-10'>SystemSerialNumber</span>.
     </p><!-- l. 5501 --><p class='noindent'>Specify special string value <span class='ec-lmtt-10'>OEM </span>to extract current value from NVRAM (<span class='ec-lmtt-10'>SSN </span>variable) or SMBIOS and use it throughout
     the sections. This feature can only be used on Mac-compatible firmware.
     </p></li>
<li class='enumerate' id='x1-58016x8'>
     <!-- l. 5505 --><p class='noindent'><span class='ec-lmtt-10'>SystemUUID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span>, GUID<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified or not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to SMBIOS <span class='ec-lmtt-10'>SystemUUID</span>.
     </p><!-- l. 5510 --><p class='noindent'>Specify special string value <span class='ec-lmtt-10'>OEM </span>to extract current value from NVRAM (<span class='ec-lmtt-10'>system-id </span>variable) or SMBIOS and use it
     throughout the sections. Since not every firmware implementation has valid (and unique) values, this feature is not
     applicable to some setups, and may provide unexpected results. It is highly recommended to specify the UUID explicitly.
     Refer to <span class='ec-lmtt-10'>UseRawUuidEncoding </span>to determine how SMBIOS value is parsed.
     </p></li>
<li class='enumerate' id='x1-58018x9'>
     <!-- l. 5517 --><p class='noindent'><span class='ec-lmtt-10'>MLB</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified or not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to SMBIOS <span class='ec-lmtt-10'>BoardSerialNumber</span>.
     </p><!-- l. 5522 --><p class='noindent'>Specify special string value <span class='ec-lmtt-10'>OEM </span>to extract current value from NVRAM (<span class='ec-lmtt-10'>MLB </span>variable) or SMBIOS and use it throughout
     the sections. This feature can only be used on Mac-compatible firmware.
     </p></li>
<li class='enumerate' id='x1-58020x10'>
     <!-- l. 5526 --><p class='noindent'><span class='ec-lmtt-10'>ROM</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist multidata</span>, 6 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified or not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Refer to <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ROM</span>.
     </p><!-- l. 5532 --><p class='noindent'>Specify special string value <span class='ec-lmtt-10'>OEM </span>to extract current value from NVRAM (<span class='ec-lmtt-10'>ROM </span>variable) and use it throughout the sections.
     This feature can only be used on Mac-compatible firmware.
</p>
     </li></ol>
<!-- l. 5538 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='datahub-properties'><span class='titlemark'>10.3   </span> <a id='x1-5900010.3'></a>DataHub Properties</h4>
<!-- l. 5540 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-59002x1'><span class='ec-lmtt-10'>PlatformName</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>name </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. The value found on Macs is <span class='ec-lmtt-10'>platform </span>in ASCII.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-59004x2'><span class='ec-lmtt-10'>SystemProductName</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Sets  <span class='ec-lmtt-10'>Model </span>in  <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>.  The  value  found  on  Macs  is  equal  to  SMBIOS
     <span class='ec-lmtt-10'>SystemProductName </span>in Unicode.
     </li>
<li class='enumerate' id='x1-59006x3'><span class='ec-lmtt-10'>SystemSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Sets  <span class='ec-lmtt-10'>SystemSerialNumber </span>in  <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>.  The  value  found  on  Macs  is  equal  to
     SMBIOS <span class='ec-lmtt-10'>SystemSerialNumber </span>in Unicode.
     </li>
<li class='enumerate' id='x1-59008x4'><span class='ec-lmtt-10'>SystemUUID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span>, GUID<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Sets  <span class='ec-lmtt-10'>system-id </span>in  <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>.  The  value  found  on  Macs  is  equal  to  SMBIOS
     <span class='ec-lmtt-10'>SystemUUID </span>(with swapped byte order).
     </li>
<li class='enumerate' id='x1-59010x5'><span class='ec-lmtt-10'>BoardProduct</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Sets  <span class='ec-lmtt-10'>board-id </span>in  <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>.  The  value  found  on  Macs  is  equal  to  SMBIOS
     <span class='ec-lmtt-10'>BoardProduct </span>in ASCII.
     </li>
<li class='enumerate' id='x1-59012x6'><span class='ec-lmtt-10'>BoardRevision</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 1 byte<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>board-rev </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. The value found on Macs seems to correspond to
     internal board revision (e.g. <span class='ec-lmtt-10'>01</span>).
     </li>
<li class='enumerate' id='x1-59014x7'>
     <!-- l. 5584 --><p class='noindent'><span class='ec-lmtt-10'>StartupPowerEvents</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Sets  <span class='ec-lmtt-10'>StartupPowerEvents </span>in  <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>.  The  value  found  on  Macs  is  power
     management state bitmask, normally 0. Known bits read by <span class='ec-lmtt-10'>X86PlatformPlugin.kext</span>:
</p>
                                                                                                  
                                                                                                  
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000001 </span>— Shutdown cause was a <span class='ec-lmtt-10'>PWROK </span>event (Same as <span class='ec-lmtt-10'>GEN_PMCON_2 </span>bit 0)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000002 </span>— Shutdown cause was a <span class='ec-lmtt-10'>SYS_PWROK </span>event (Same as <span class='ec-lmtt-10'>GEN_PMCON_2 </span>bit 1)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000004 </span>— Shutdown cause was a <span class='ec-lmtt-10'>THRMTRIP# </span>event (Same as <span class='ec-lmtt-10'>GEN_PMCON_2 </span>bit 3)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000008 </span>— Rebooted due to a SYS_RESET# event (Same as <span class='ec-lmtt-10'>GEN_PMCON_2 </span>bit 4)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000010 </span>— Power Failure (Same as <span class='ec-lmtt-10'>GEN_PMCON_3 </span>bit 1 <span class='ec-lmtt-10'>PWR_FLR</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000020 </span>— Loss of RTC Well Power (Same as <span class='ec-lmtt-10'>GEN_PMCON_3 </span>bit 2 <span class='ec-lmtt-10'>RTC_PWR_STS</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000040 </span>— General Reset Status (Same as <span class='ec-lmtt-10'>GEN_PMCON_3 </span>bit 9 <span class='ec-lmtt-10'>GEN_RST_STS</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0xffffff80 </span>— SUS Well Power Loss (Same as <span class='ec-lmtt-10'>GEN_PMCON_3 </span>bit 14)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00010000 </span>— Wake cause was a ME Wake event (Same as PRSTS bit 0, <span class='ec-lmtt-10'>ME_WAKE_STS</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00020000 </span>— Cold Reboot was ME Induced event (Same as <span class='ec-lmtt-10'>PRSTS </span>bit 1 <span class='ec-lmtt-10'>ME_HRST_COLD_STS</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00040000 </span>— Warm Reboot was ME Induced event (Same as <span class='ec-lmtt-10'>PRSTS </span>bit 2 <span class='ec-lmtt-10'>ME_HRST_WARM_STS</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00080000 </span>— Shutdown was ME Induced event (Same as <span class='ec-lmtt-10'>PRSTS </span>bit 3 <span class='ec-lmtt-10'>ME_HOST_PWRDN</span>)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00100000 </span>— Global reset ME Watchdog Timer event (Same as <span class='ec-lmtt-10'>PRSTS </span>bit 6)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00200000 </span>— Global reset PowerManagement Watchdog Timer event (Same as <span class='ec-lmtt-10'>PRSTS </span>bit 15)</li></ul>
     </li>
<li class='enumerate' id='x1-59016x8'><span class='ec-lmtt-10'>InitialTSC</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>InitialTSC </span>in <span class='ec-lmtt-10'>gEfiProcessorSubClassGuid</span>. Sets initial TSC value, normally 0.
     </li>
<li class='enumerate' id='x1-59018x9'>
     <!-- l. 5644 --><p class='noindent'><span class='ec-lmtt-10'>FSBFrequency</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Automatic)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>FSBFrequency </span>in <span class='ec-lmtt-10'>gEfiProcessorSubClassGuid</span>.
     </p><!-- l. 5650 --><p class='noindent'>Sets CPU FSB frequency. This value equals to CPU nominal frequency divided by CPU maximum bus ratio and is
     specified in Hz. Refer to <span class='ec-lmtt-10'>MSR_NEHALEM_PLATFORM_INFO</span> (<span class='ec-lmtt-10'>CEh</span>) MSR value to determine maximum bus ratio on modern
     Intel CPUs.
     </p><!-- l. 5655 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This value is not used on Skylake and newer but is still provided to follow suit.
     </p></li>
<li class='enumerate' id='x1-59020x10'>
     <!-- l. 5658 --><p class='noindent'><span class='ec-lmtt-10'>ARTFrequency</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Automatic)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>ARTFrequency </span>in <span class='ec-lmtt-10'>gEfiProcessorSubClassGuid</span>.
     </p><!-- l. 5664 --><p class='noindent'>This value contains CPU ART frequency, also known as crystal clock frequency. Its existence is exclusive to the Skylake
     generation and newer. The value is specified in Hz, and is normally 24 MHz for the client Intel segment, 25 MHz for the
     server Intel segment, and 19.2 MHz for Intel Atom CPUs. macOS till 10.15 inclusive assumes 24 MHz by
     default.
     </p><!-- l. 5669 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: On Intel Skylake X ART frequency may be a little less (approx. 0.25%) than 24 or 25 MHz due to special
     EMI-reduction circuit as described in <a href='https://github.com/acidanthera/bugtracker/issues/448#issuecomment-524914166'>Acidanthera Bugtracker</a>.
     </p></li>
<li class='enumerate' id='x1-59022x11'><span class='ec-lmtt-10'>DevicePathsSupported</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>DevicePathsSupported </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. Must be set to <span class='ec-lmtt-10'>1 </span>for AppleACPIPlatform.kext to
     append SATA device paths to <span class='ec-lmtt-10'>Boot#### </span>and <span class='ec-lmtt-10'>efi-boot-device-data </span>variables. Set to <span class='ec-lmtt-10'>1 </span>on all modern
     Macs.
     </li>
<li class='enumerate' id='x1-59024x12'><span class='ec-lmtt-10'>SmcRevision</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 6 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>REV </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. Custom property read by <span class='ec-lmtt-10'>VirtualSMC </span>or <span class='ec-lmtt-10'>FakeSMC </span>to generate SMC
     <span class='ec-lmtt-10'>REV </span>key.
     </li>
<li class='enumerate' id='x1-59026x13'><span class='ec-lmtt-10'>SmcBranch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>RBr </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. Custom property read by <span class='ec-lmtt-10'>VirtualSMC </span>or <span class='ec-lmtt-10'>FakeSMC </span>to generate SMC
     <span class='ec-lmtt-10'>RBr </span>key.
     </li>
<li class='enumerate' id='x1-59028x14'><span class='ec-lmtt-10'>SmcPlatform</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets <span class='ec-lmtt-10'>RPlt </span>in <span class='ec-lmtt-10'>gEfiMiscSubClassGuid</span>. Custom property read by <span class='ec-lmtt-10'>VirtualSMC </span>or <span class='ec-lmtt-10'>FakeSMC </span>to generate SMC
                                                                                                  
                                                                                                  
     <span class='ec-lmtt-10'>RPlt </span>key.</li></ol>
<!-- l. 5707 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='memory-properties'><span class='titlemark'>10.4   </span> <a id='x1-6000010.4'></a>Memory Properties</h4>
<!-- l. 5709 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-60002x1'><span class='ec-lmtt-10'>DataWidth</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 16-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0xFFFF </span>(unknown)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Data Width<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the data width, in bits, of the memory. A <span class='ec-lmtt-10'>DataWidth </span>of <span class='ec-lmtt-10'>0 </span>and a <span class='ec-lmtt-10'>TotalWidth </span>of <span class='ec-lmtt-10'>8 </span>indicates
     that the device is being used solely to provide 8 error-correction bits.
     </li>
<li class='enumerate' id='x1-60004x2'>
     <!-- l. 5721 --><p class='noindent'><span class='ec-lmtt-10'>Devices</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the custom memory devices to be added.
     </p><!-- l. 5726 --><p class='noindent'>To be filled with  <span class='ec-lmtt-10'>plist dictionary </span>values, describing each memory device. Refer to the <a href='#memory-device-properties'>Memory Devices
     Properties</a> section below. This should include all memory slots, even if unpopulated.
     </p></li>
<li class='enumerate' id='x1-60006x3'>
     <!-- l. 5731 --><p class='noindent'><span class='ec-lmtt-10'>ErrorCorrection</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 8-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x03</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Physical Memory Array (Type 16) — Memory Error Correction<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the primary hardware error correction or detection method supported by the memory.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— Other
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>— Unknown
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x03 </span>— None
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x04 </span>— Parity
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x05 </span>— Single-bit ECC
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x06 </span>— Multi-bit ECC
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x07 </span>— CRC</li></ul>
     </li>
<li class='enumerate' id='x1-60008x4'>
     <!-- l. 5757 --><p class='noindent'><span class='ec-lmtt-10'>FormFactor</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 8-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x02</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Form Factor<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the form factor of the memory. On Macs, this should typically be DIMM or SODIMM.
     Commonly used form factors are listed below.
     </p><!-- l. 5765 --><p class='noindent'>When <span class='ec-lmtt-10'>CustomMemory </span>is <span class='ec-lmtt-10'>false</span>, this value is automatically set based on Mac product name.
     </p><!-- l. 5768 --><p class='noindent'>When <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>true</span>, the original value from the the corresponding Mac model will be set if available. Otherwise, the
     value from <span class='ec-lmtt-10'>OcMacInfoLib </span>will be set. When <span class='ec-lmtt-10'>Automatic </span>is <span class='ec-lmtt-10'>false</span>, a user-specified value will be set if available.
     Otherwise, the original value from the firmware will be set. If no value is provided, the failsafe value will be
     set.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— Other
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>— Unknown
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x09 </span>— DIMM
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0D </span>— SODIMM
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0F </span>— FB-DIMM</li></ul>
     </li>
<li class='enumerate' id='x1-60010x5'><span class='ec-lmtt-10'>MaxCapacity</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 64-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Physical Memory Array (Type 16) — Maximum Capacity<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the maximum amount of memory, in bytes, supported by the system.
     </li>
<li class='enumerate' id='x1-60012x6'><span class='ec-lmtt-10'>TotalWidth</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 16-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0xFFFF </span>(unknown)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Total Width<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the total width, in bits, of the memory, including any check or error-correction bits. If there are
     no error-correction bits, this value should be equal to <span class='ec-lmtt-10'>DataWidth</span>.
     </li>
<li class='enumerate' id='x1-60014x7'>
     <!-- l. 5806 --><p class='noindent'><span class='ec-lmtt-10'>Type</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 8-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x02</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Memory Type<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the memory type. Commonly used types are listed below.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0x01 </span>— Other
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x02 </span>— Unknown
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x0F </span>— SDRAM
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x12 </span>— DDR
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x13 </span>— DDR2
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x14 </span>— DDR2 FB-DIMM
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x18 </span>— DDR3
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x1A </span>— DDR4
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x1B </span>— LPDDR
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x1C </span>— LPDDR2
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x1D </span>— LPDDR3
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x1E </span>— LPDDR4</li></ul>
     </li>
<li class='enumerate' id='x1-60016x8'>
     <!-- l. 5841 --><p class='noindent'><span class='ec-lmtt-10'>TypeDetail</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 16-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0x4</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Type Detail<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies additional memory type information.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 0 </span>— Reserved, set to 0
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 1 </span>— Other
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 2 </span>— Unknown
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 7 </span>— Synchronous
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 13 </span>— Registered (buffered)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Bit 14 </span>— Unbuffered (unregistered)</li></ul>
     </li></ol>
<!-- l. 5865 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='memory-device-properties'><span class='titlemark'>10.4.1   </span> <a id='x1-6100010.4.1'></a>Memory Device Properties</h5>
<!-- l. 5867 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-61002x1'><span class='ec-lmtt-10'>AssetTag</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Asset Tag<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the asset tag of this memory device.
     </li>
<li class='enumerate' id='x1-61004x2'><span class='ec-lmtt-10'>BankLocator</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Bank Locator<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the physically labeled bank where the memory device is located.
     </li>
<li class='enumerate' id='x1-61006x3'><span class='ec-lmtt-10'>DeviceLocator</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Device Locator<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the physically-labeled socket or board position where the memory device is located.
     </li>
<li class='enumerate' id='x1-61008x4'>
     <!-- l. 5892 --><p class='noindent'><span class='ec-lmtt-10'>Manufacturer</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Manufacturer<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the manufacturer of this memory device.
     </p><!-- l. 5898 --><p class='noindent'>For empty slot this must be set to <span class='ec-lmtt-10'>NO DIMM </span>for macOS System Profiler to correctly display memory slots on
     certain Mac models, e.g. <span class='ec-lmtt-10'>MacPro7,1</span>. <span class='ec-lmtt-10'>MacPro7,1 </span>imposes additional requirements on the memory layout:
     </p>
         <ul class='itemize1'>
         <li class='itemize'>The amount of installed sticks must one of the following: 4, 6, 8, 10, 12. Using any different value will cause
         an error in the System Profiler.
         </li>
         <li class='itemize'>The amount of memory slots must equal to 12. Using any different value will cause an error in the System
         Profiler.
         </li>
         <li class='itemize'>Memory sticks must be installed in dedicated memory slots as explained on the <a href='https://support.apple.com/HT210103'>support page</a>. SMBIOS
         memory devices are mapped to the following slots: <span class='ec-lmtt-10'>8, 7, 10, 9, 12, 11, 5, 6, 3, 4, 1, 2</span>.</li></ul>
     </li>
<li class='enumerate' id='x1-61010x5'><span class='ec-lmtt-10'>PartNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Part Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the part number of this memory device.
     </li>
<li class='enumerate' id='x1-61012x6'><span class='ec-lmtt-10'>SerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Unknown</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Serial Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the serial number of this memory device.
     </li>
<li class='enumerate' id='x1-61014x7'><span class='ec-lmtt-10'>Size</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Size<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the size of the memory device, in megabytes. <span class='ec-lmtt-10'>0 </span>indicates this slot is not populated.
     </li>
<li class='enumerate' id='x1-61016x8'><span class='ec-lmtt-10'>Speed</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 16-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Memory Device (Type 17) — Speed<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the maximum capable speed of the device, in megatransfers per second (MT/s). <span class='ec-lmtt-10'>0 </span>indicates an
     unknown speed.
</li></ol>
<!-- l. 5945 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='platformnvram-properties'><span class='titlemark'>10.5   </span> <a id='x1-6200010.5'></a>PlatformNVRAM Properties</h4>
<!-- l. 5947 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-62002x1'><span class='ec-lmtt-10'>BID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the value of NVRAM variable <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_BID</span>.
     </li>
<li class='enumerate' id='x1-62004x2'><span class='ec-lmtt-10'>ROM</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 6 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the values of NVRAM variables <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_ROM </span>and
     <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ROM</span>.
     </li>
<li class='enumerate' id='x1-62006x3'><span class='ec-lmtt-10'>MLB</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the values of NVRAM variables <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_MLB </span>and
     <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:MLB</span>.
     </li>
<li class='enumerate' id='x1-62008x4'>
     <!-- l. 5972 --><p class='noindent'><span class='ec-lmtt-10'>FirmwareFeatures</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: This variable comes in pair with <span class='ec-lmtt-10'>FirmwareFeaturesMask</span>. Specifies the values of NVRAM variables:
     </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:FirmwareFeatures</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ExtendedFirmwareFeatures</span></li></ul>
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-62010x5'>
     <!-- l. 5984 --><p class='noindent'><span class='ec-lmtt-10'>FirmwareFeaturesMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: This variable comes in pair with <span class='ec-lmtt-10'>FirmwareFeatures</span>. Specifies the values of NVRAM variables:
     </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:FirmwareFeaturesMask</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ExtendedFirmwareFeaturesMask</span></li></ul>
     </li>
<li class='enumerate' id='x1-62012x6'><span class='ec-lmtt-10'>SystemSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the values of NVRAM variables <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW_SSN </span>and
     <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:SSN</span>.
     </li>
<li class='enumerate' id='x1-62014x7'><span class='ec-lmtt-10'>SystemUUID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Not installed)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Specifies the value of NVRAM variable <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:system-id </span>for boot
     services only. The value found on Macs is equal to SMBIOS <span class='ec-lmtt-10'>SystemUUID</span>.
</li></ol>
<!-- l. 6014 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='smbios-properties'><span class='titlemark'>10.6   </span> <a id='x1-6300010.6'></a>SMBIOS Properties</h4>
<!-- l. 6016 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-63002x1'><span class='ec-lmtt-10'>BIOSVendor</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: BIOS Information (Type 0) — Vendor<br class='newline' /><span class='ec-lmbx-10'>Description</span>: BIOS Vendor. All rules of <span class='ec-lmtt-10'>SystemManufacturer </span>do apply.
     </li>
<li class='enumerate' id='x1-63004x2'>
     <!-- l. 6025 --><p class='noindent'><span class='ec-lmtt-10'>BIOSVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: BIOS Information (Type 0) — BIOS Version<br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Firmware  version.  This  value  gets  updated  and  takes  part  in  update  delivery  configuration
     and  macOS  version  compatibility.  This  value  could  look  like  <span class='ec-lmtt-10'>MM71.88Z.0234.B00.1809171422 </span>in  older
     firmware   and   is   described   in   <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/Guid/BiosId.h'>BiosId.h</a>.   In   newer   firmware,   it   should   look   like   <span class='ec-lmtt-10'>236.0.0.0.0  </span>or
     <span class='ec-lmtt-10'>220.230.16.0.0 (iBridge: 16.16.2542.0.0,0)</span>. iBridge version is read from <span class='ec-lmtt-10'>BridgeOSVersion </span>variable, and
     is only present on macs with T2.
                                                                                                  
                                                                                                  
</p>
     <pre class='verbatim' id='verbatim-1'>
     Apple ROM Version
      BIOS ID:      MBP151.88Z.F000.B00.1811142212
      Model:        MBP151
      EFI Version:  220.230.16.0.0
      Built by:     root@quinoa
      Date:         Wed Nov 14 22:12:53 2018
      Revision:     220.230.16 (B&amp;I)
      ROM Version:  F000_B00
      Build Type:   Official Build, RELEASE
      Compiler:     Apple LLVM version 10.0.0 (clang-1000.2.42)
      UUID:         E5D1475B-29FF-32BA-8552-682622BA42E1
      UUID:         151B0907-10F9-3271-87CD-4BF5DBECACF5</pre>
     <!-- l. 6053 --><p class='nopar'>
     </p></li>
<li class='enumerate' id='x1-63006x3'><span class='ec-lmtt-10'>BIOSReleaseDate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: BIOS Information (Type 0) — BIOS Release Date<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Firmware release date. Similar to <span class='ec-lmtt-10'>BIOSVersion</span>. May look like <span class='ec-lmtt-10'>12/08/2017</span>.
     </li>
<li class='enumerate' id='x1-63008x4'><span class='ec-lmtt-10'>SystemManufacturer</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — Manufacturer<br class='newline' /><span class='ec-lmbx-10'>Description</span>: OEM manufacturer of the particular board. Use failsafe unless strictly required. Do not override to contain
     <span class='ec-lmtt-10'>Apple Inc. </span>on non-Apple hardware, as this confuses numerous services present in the operating system, such as firmware
     updates, eficheck, as well as kernel extensions developed in Acidanthera, such as Lilu and its plugins. In addition it will
     also make some operating systems such as Linux unbootable.
     </li>
<li class='enumerate' id='x1-63010x5'>
     <!-- l. 6074 --><p class='noindent'><span class='ec-lmtt-10'>SystemProductName</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1), Product Name<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Preferred Mac model used to mark the device as supported by the operating system. This value must be
     specified by any configuration for later automatic generation of the related values in this and other SMBIOS tables and
     related configuration parameters. If <span class='ec-lmtt-10'>SystemProductName </span>is not compatible with the target operating system,
     <span class='ec-lmtt-10'>-no_compat_check </span>boot argument may be used as an override.
     </p><!-- l. 6086 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: If <span class='ec-lmtt-10'>SystemProductName </span>is unknown, and related fields are unspecified, default values should be assumed as being
     set to <span class='ec-lmtt-10'>MacPro6,1 </span>data. The list of known products can be found in <span class='ec-lmtt-10'>AppleModels</span>.
     </p></li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-63012x6'><span class='ec-lmtt-10'>SystemVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — Version<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Product iteration version number. May look like <span class='ec-lmtt-10'>1.1</span>.
     </li>
<li class='enumerate' id='x1-63014x7'><span class='ec-lmtt-10'>SystemSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — Serial Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Product serial number in defined format. Known formats are described in <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Utilities/macserial/FORMAT.md'>macserial</a>.
     </li>
<li class='enumerate' id='x1-63016x8'><span class='ec-lmtt-10'>SystemUUID</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span>, GUID<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — UUID<br class='newline' /><span class='ec-lmbx-10'>Description</span>: A UUID is an identifier that is designed to be unique across both time and space. It requires no central
     registration process.
     </li>
<li class='enumerate' id='x1-63018x9'><span class='ec-lmtt-10'>SystemSKUNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — SKU Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Mac Board ID (<span class='ec-lmtt-10'>board-id</span>). May look like <span class='ec-lmtt-10'>Mac-7BA5B2D9E42DDD94 </span>or <span class='ec-lmtt-10'>Mac-F221BEC8 </span>in older models.
     Sometimes it can be just empty.
     </li>
<li class='enumerate' id='x1-63020x10'><span class='ec-lmtt-10'>SystemFamily</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Information (Type 1) — Family<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Family name. May look like <span class='ec-lmtt-10'>iMac Pro</span>.
     </li>
<li class='enumerate' id='x1-63022x11'><span class='ec-lmtt-10'>BoardManufacturer</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) - Manufacturer<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Board manufacturer. All rules of <span class='ec-lmtt-10'>SystemManufacturer </span>do apply.
     </li>
<li class='enumerate' id='x1-63024x12'><span class='ec-lmtt-10'>BoardProduct</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) - Product<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Mac Board ID (<span class='ec-lmtt-10'>board-id</span>). May look like <span class='ec-lmtt-10'>Mac-7BA5B2D9E42DDD94 </span>or <span class='ec-lmtt-10'>Mac-F221BEC8 </span>in older
     models.
     </li>
<li class='enumerate' id='x1-63026x13'><span class='ec-lmtt-10'>BoardVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) - Version<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Board version number. Varies, may match <span class='ec-lmtt-10'>SystemProductName </span>or <span class='ec-lmtt-10'>SystemProductVersion</span>.
     </li>
<li class='enumerate' id='x1-63028x14'><span class='ec-lmtt-10'>BoardSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) — Serial Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Board serial number in defined format. Known formats are described in <a href='https://github.com/acidanthera/macserial/blob/master/FORMAT.md'>macserial</a>.
     </li>
<li class='enumerate' id='x1-63030x15'><span class='ec-lmtt-10'>BoardAssetTag</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) — Asset Tag<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Asset tag number. Varies, may be empty or <span class='ec-lmtt-10'>Type2 - Board Asset Tag</span>.
     </li>
<li class='enumerate' id='x1-63032x16'><span class='ec-lmtt-10'>BoardType</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) — Board Type<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Either <span class='ec-lmtt-10'>0xA </span>(Motherboard (includes processor, memory, and I/O) or <span class='ec-lmtt-10'>0xB </span>(Processor/Memory Module).
     Refer to Table 15 – Baseboard: Board Type for details.
     </li>
<li class='enumerate' id='x1-63034x17'><span class='ec-lmtt-10'>BoardLocationInChassis</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: Baseboard (or Module) Information (Type 2) — Location in Chassis<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Varies, may be empty or <span class='ec-lmtt-10'>Part Component</span>.
     </li>
<li class='enumerate' id='x1-63036x18'><span class='ec-lmtt-10'>ChassisManufacturer</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Enclosure or Chassis (Type 3) — Manufacturer<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Board manufacturer. All rules of <span class='ec-lmtt-10'>SystemManufacturer </span>do apply.
     </li>
<li class='enumerate' id='x1-63038x19'><span class='ec-lmtt-10'>ChassisType</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Enclosure or Chassis (Type 3) — Type<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Chassis type. Refer to Table 17 — System Enclosure or Chassis Types for details.
     </li>
<li class='enumerate' id='x1-63040x20'><span class='ec-lmtt-10'>ChassisVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Enclosure or Chassis (Type 3) — Version<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Should match <span class='ec-lmtt-10'>BoardProduct</span>.
     </li>
<li class='enumerate' id='x1-63042x21'><span class='ec-lmtt-10'>ChassisSerialNumber</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Enclosure or Chassis (Type 3) — Version<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Should match <span class='ec-lmtt-10'>SystemSerialNumber</span>.
     </li>
<li class='enumerate' id='x1-63044x22'><span class='ec-lmtt-10'>ChassisAssetTag</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (OEM specified)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: System Enclosure or Chassis (Type 3) — Asset Tag Number<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Chassis type name. Varies, could be empty or <span class='ec-lmtt-10'>MacBook-Aluminum</span>.
     </li>
<li class='enumerate' id='x1-63046x23'><span class='ec-lmtt-10'>PlatformFeature</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 32-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0xFFFFFFFF </span>(OEM specified on Apple hardware, do not provide the table otherwise)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: <span class='ec-lmtt-10'>APPLE_SMBIOS_TABLE_TYPE133 </span>- <span class='ec-lmtt-10'>PlatformFeature</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Platform features bitmask (Missing on older Macs). Refer to <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/IndustryStandard/AppleFeatures.h'>AppleFeatures.h</a> for details.
     </li>
<li class='enumerate' id='x1-63048x24'><span class='ec-lmtt-10'>SmcVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 16 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: All zero (OEM specified on Apple hardware, do not provide the table otherwise)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: <span class='ec-lmtt-10'>APPLE_SMBIOS_TABLE_TYPE134 </span>- <span class='ec-lmtt-10'>Version</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: ASCII string containing SMC version in upper case. Missing on T2 based Macs.
     </li>
<li class='enumerate' id='x1-63050x25'><span class='ec-lmtt-10'>FirmwareFeatures</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(OEM specified on Apple hardware, 0 otherwise)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: <span class='ec-lmtt-10'>APPLE_SMBIOS_TABLE_TYPE128 </span>- <span class='ec-lmtt-10'>FirmwareFeatures </span>and <span class='ec-lmtt-10'>ExtendedFirmwareFeatures</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: 64-bit firmware features bitmask. Refer to <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/IndustryStandard/AppleFeatures.h'>AppleFeatures.h</a> for details. Lower 32 bits match
     <span class='ec-lmtt-10'>FirmwareFeatures</span>. Upper 64 bits match <span class='ec-lmtt-10'>ExtendedFirmwareFeatures</span>.
     </li>
<li class='enumerate' id='x1-63052x26'><span class='ec-lmtt-10'>FirmwareFeaturesMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist data</span>, 8 bytes<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(OEM specified on Apple hardware, 0 otherwise)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: <span class='ec-lmtt-10'>APPLE_SMBIOS_TABLE_TYPE128 </span>- <span class='ec-lmtt-10'>FirmwareFeaturesMask </span>and <span class='ec-lmtt-10'>ExtendedFirmwareFeaturesMask</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Supported bits of extended firmware features bitmask. Refer to <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/IndustryStandard/AppleFeatures.h'>AppleFeatures.h</a> for details. Lower 32 bits
     match <span class='ec-lmtt-10'>FirmwareFeaturesMask</span>. Upper 64 bits match <span class='ec-lmtt-10'>ExtendedFirmwareFeaturesMask</span>.
     </li>
<li class='enumerate' id='x1-63054x27'>
     <!-- l. 6258 --><p class='noindent'><span class='ec-lmtt-10'>ProcessorType</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 16-bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0 </span>(Automatic)<br class='newline' /><span class='ec-lmbx-10'>SMBIOS</span>: <span class='ec-lmtt-10'>APPLE_SMBIOS_TABLE_TYPE131 </span>- <span class='ec-lmtt-10'>ProcessorType</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Combined of Processor Major and Minor types.
     </p><!-- l. 6265 --><p class='noindent'>Automatic value generation attempts to provide the most accurate value for the currently installed CPU. When this fails,
     please raise an <a href='https://github.com/acidanthera/bugtracker/issues'>issue</a> and provide <span class='ec-lmtt-10'>sysctl machdep.cpu </span>and <a href='https://github.com/acidanthera/dmidecode'><span class='ec-lmtt-10'>dmidecode</span></a> output. For a full list of available values and their
     limitations (the value will only apply if the CPU core count matches), refer to the Apple SMBIOS definitions header
     <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/IndustryStandard/AppleSmBios.h'>here</a>.</p></li></ol>
<!-- l. 6275 --><p class='noindent'>
</p>
<h3 class='sectionHead' id='uefi'><span class='titlemark'>11   </span> <a id='x1-6400011'></a>UEFI</h3>
<!-- l. 6277 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='introduction7'><span class='titlemark'>11.1   </span> <a id='x1-6500011.1'></a>Introduction</h4>
<!-- l. 6279 --><p class='noindent'><a href='https://uefi.org/specifications'>UEFI</a> (Unified Extensible Firmware Interface) is a specification that defines a software interface between an operating system
and platform firmware. This section allows loading additional UEFI modules as well as applying tweaks to the onboard
firmware. To inspect firmware contents, apply modifications and perform upgrades <a href='https://github.com/LongSoft/UEFITool/releases'>UEFITool</a> and supplementary utilities can
be used.
</p><!-- l. 6286 --><p class='noindent'>
</p>
                                                                                                  
                                                                                                  
<h4 class='subsectionHead' id='drivers'><span class='titlemark'>11.2   </span> <a id='x1-6600011.2'></a>Drivers</h4>
<!-- l. 6288 --><p class='noindent'>Depending on the firmware, a different set of drivers may be required. Loading an incompatible driver may lead the
system to unbootable state or even cause permanent firmware damage. Some of the known drivers are listed
below:
</p><!-- l. 6292 --><p class='noindent'>
<a id='x1-66001r1'></a></p>
<!-- l. 6293 --><div class='longtable'> <table class='longtable' id='TBL-4'><colgroup id='TBL-4-1g'><col id='TBL-4-1' /><col id='TBL-4-2' /></colgroup>
<tr id='TBL-4-1-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-1-1' style='white-space:normal; text-align:left;'>
<!-- l. 6293 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>AudioDxe</span></a><span class='ec-lmbx-10'>*</span>            </p></td><td class='td11' id='TBL-4-1-2' style='white-space:normal; text-align:left;'>
<!-- l. 6294 --><p class='noindent'><a href='#audiodxe'>HDA  audio  support  driver</a>  in  UEFI  firmware  for  most  Intel  and  some  other  analog
audio controllers. Staging driver, refer to <a href='https://github.com/acidanthera/bugtracker/issues/740'>acidanthera/bugtracker#740</a> for known issues in
AudioDxe.                                                                                                          </p></td>
</tr><tr id='TBL-4-2-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-2-1' style='white-space:normal; text-align:left;'>
<!-- l. 6297 --><p class='noindent'><a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>btrfs_x64</span></a>         </p></td><td class='td11' id='TBL-4-2-2' style='white-space:normal; text-align:left;'>
<!-- l. 6298 --><p class='noindent'>Open source BTRFS file system driver, required for booting with <a href='#openlinuxboot'>OpenLinuxBoot</a> from a file
system which is now quite commonly used with Linux.                                                </p></td>
</tr><tr id='TBL-4-3-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-3-1' style='white-space:normal; text-align:left;'>
<!-- l. 6300 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>BiosVideo</span></a><span class='ec-lmbx-10'>*</span>           </p></td><td class='td11' id='TBL-4-3-2' style='white-space:normal; text-align:left;'>
<!-- l. 6301 --><p class='noindent'>CSM video driver implementing graphics output protocol based on VESA and legacy BIOS
interfaces. Used for UEFI firmware with fragile GOP support (e.g. low resolution). Requires
<span class='ec-lmtt-10'>ReconnectGraphicsOnConnect</span>. Included in OpenDuet out of the box.                            </p></td>
</tr><tr id='TBL-4-4-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-4-1' style='white-space:normal; text-align:left;'>
<!-- l. 6304 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>CrScreenshotDxe</span></a><span class='ec-lmbx-10'>*</span>  </p></td><td class='td11' id='TBL-4-4-2' style='white-space:normal; text-align:left;'>
<!-- l. 6305 --><p class='noindent'>Screenshot  making  driver  saving  images  to  the  root  of  OpenCore  partition  (ESP)  or
any  available  writeable  filesystem  upon  pressing  <span class='ec-lmtt-10'>F10</span>.  This  is  a  modified  version  of
<a href='https://github.com/LongSoft/CrScreenshotDxe'><span class='ec-lmtt-10'>CrScreenshotDxe</span></a> driver by <a href='https://github.com/NikolajSchlej'>Nikolaj Schlej</a>.                                                                </p></td>
</tr><tr id='TBL-4-5-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-5-1' style='white-space:normal; text-align:left;'>
<!-- l. 6309 --><p class='noindent'><a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>ExFatDxe</span></a>          </p></td><td class='td11' id='TBL-4-5-2' style='white-space:normal; text-align:left;'>
<!-- l. 6310 --><p class='noindent'>Proprietary  ExFAT  file  system  driver  for  Bootcamp  support  commonly  found  in  Apple
firmware. For Sandy Bridge and earlier CPUs, the <span class='ec-lmtt-10'>ExFatDxeLegacy </span>driver should be used
due to the lack of <span class='ec-lmtt-10'>RDRAND </span>instruction support.                                                           </p></td>
</tr><tr id='TBL-4-6-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-6-1' style='white-space:normal; text-align:left;'>
<!-- l. 6313 --><p class='noindent'><a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>ext4_x64</span></a>          </p></td><td class='td11' id='TBL-4-6-2' style='white-space:normal; text-align:left;'>
<!-- l. 6314 --><p class='noindent'>Open source EXT4 file system driver, required for booting with <a href='#openlinuxboot'>OpenLinuxBoot</a> from the
file system most commonly used with Linux.                                                              </p></td>
</tr><tr id='TBL-4-7-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-7-1' style='white-space:normal; text-align:left;'>
<!-- l. 6316 --><p class='noindent'><a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>HfsPlus</span></a>           </p></td><td class='td11' id='TBL-4-7-2' style='white-space:normal; text-align:left;'>
<!-- l. 6317 --><p class='noindent'>Recommended. Proprietary HFS file system driver with bless support commonly found in
Apple firmware. For Sandy Bridge and earlier CPUs, the <span class='ec-lmtt-10'>HfsPlusLegacy </span>driver should be
used due to the lack of <span class='ec-lmtt-10'>RDRAND </span>instruction support.                                                     </p></td>
</tr><tr id='TBL-4-8-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-8-1' style='white-space:normal; text-align:left;'>
<!-- l. 6320 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>HiiDatabase</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-8-2' style='white-space:normal; text-align:left;'>
<!-- l. 6321 --><p class='noindent'>HII services support driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. This driver is included in most types of
firmware starting with the Ivy Bridge generation. Some applications with GUI, such as UEFI
Shell, may need this driver to work properly.                                                              </p></td>
</tr><tr id='TBL-4-9-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-9-1' style='white-space:normal; text-align:left;'>
<!-- l. 6324 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>EnhancedFatDxe</span></a>    </p></td><td class='td11' id='TBL-4-9-2' style='white-space:normal; text-align:left;'>
<!-- l. 6325 --><p class='noindent'>FAT  filesystem  driver  from  <span class='ec-lmtt-10'>FatPkg</span>.  This  driver  is  embedded  in  all  UEFI  firmware  and
cannot  be  used  from  OpenCore.  Several  types  of  firmware  have  defective  FAT  support
implementation that may lead to corrupted filesystems on write attempts. Embedding this
driver within the firmware may be required in case writing to the EFI partition is needed
during the boot process.                                                                                        </p></td>
</tr><tr id='TBL-4-10-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-10-1' style='white-space:normal; text-align:left;'>
<!-- l. 6330 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>NvmExpressDxe</span></a><span class='ec-lmbx-10'>*</span>     </p></td><td class='td11' id='TBL-4-10-2' style='white-space:normal; text-align:left;'>
<!-- l. 6331 --><p class='noindent'>NVMe support driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. This driver is included in most firmware starting
with the Broadwell generation. For Haswell and earlier, embedding it within the firmware
may be more favourable in case a NVMe SSD drive is installed.                                     </p></td>
</tr><tr id='TBL-4-11-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-11-1' style='white-space:normal; text-align:left;'>
<!-- l. 6334 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenCanopy</span></a><span class='ec-lmbx-10'>*</span>         </p></td><td class='td11' id='TBL-4-11-2' style='white-space:normal; text-align:left;'>
<!-- l. 6335 --><p class='noindent'><a href='#opencanopy'>OpenCore plugin</a> implementing graphical interface.                                                     </p></td>
</tr><tr id='TBL-4-12-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-12-1' style='white-space:normal; text-align:left;'>
<!-- l. 6336 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenRuntime</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-12-2' style='white-space:normal; text-align:left;'>
<!-- l. 6337 --><p class='noindent'><a href='#openruntime'>OpenCore plugin</a> implementing <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol.                                    </p></td>
</tr><tr id='TBL-4-13-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-13-1' style='white-space:normal; text-align:left;'>
<!-- l. 6338 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenLinuxBoot</span></a><span class='ec-lmbx-10'>*</span>     </p></td><td class='td11' id='TBL-4-13-2' style='white-space:normal; text-align:left;'>
<!-- l. 6339 --><p class='noindent'><a href='#openlinuxboot'>OpenCore  plugin</a>  implementing  <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL </span>to  allow  direct  detection  and
booting of Linux distributiuons from OpenCore, without chainloading via GRUB.             </p></td>
</tr><tr id='TBL-4-14-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-14-1' style='white-space:normal; text-align:left;'>
<!-- l. 6342 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenNtfsDxe</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-14-2' style='white-space:normal; text-align:left;'>
<!-- l. 6343 --><p class='noindent'>New Technologies File System (NTFS) read-only driver. NTFS is the primary file system for
Microsoft Windows versions that are based on Windows NT.                                        </p></td>
</tr><tr id='TBL-4-15-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-15-1' style='white-space:normal; text-align:left;'>
<!-- l. 6345 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenUsbKbDxe</span></a><span class='ec-lmbx-10'>*</span>       </p></td><td class='td11' id='TBL-4-15-2' style='white-space:normal; text-align:left;'>
<!-- l. 6346 --><p class='noindent'>USB keyboard driver adding support for <span class='ec-lmtt-10'>AppleKeyMapAggregator </span>protocols on top of a
custom USB keyboard driver implementation. This is an alternative to builtin <span class='ec-lmtt-10'>KeySupport</span>,
which may work better or worse depending on the firmware.                                         </p></td>
                                                                                                  
                                                                                                  
</tr><tr id='TBL-4-16-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-16-1' style='white-space:normal; text-align:left;'>
<!-- l. 6349 --><p class='noindent'><a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>OpenPartitionDxe</span></a><span class='ec-lmbx-10'>*</span> </p></td><td class='td11' id='TBL-4-16-2' style='white-space:normal; text-align:left;'>
<!-- l. 6350 --><p class='noindent'>Partition management driver with Apple Partitioning Scheme support. This driver can be
used to support loading older DMG recoveries such as macOS 10.9 using Apple Partitioning
Scheme. OpenDuet already includes this driver.                                                          </p></td>
</tr><tr id='TBL-4-17-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-17-1' style='white-space:normal; text-align:left;'>
<!-- l. 6353 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>Ps2KeyboardDxe</span></a><span class='ec-lmbx-10'>*</span>    </p></td><td class='td11' id='TBL-4-17-2' style='white-space:normal; text-align:left;'>
<!-- l. 6354 --><p class='noindent'>PS/2 keyboard driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. <span class='ec-lmtt-10'>OpenDuetPkg </span>and some types of firmware may not
include this driver, but it is necessary for PS/2 keyboard to work. Note, unlike <span class='ec-lmtt-10'>OpenUsbKbDxe</span>
this driver has no <span class='ec-lmtt-10'>AppleKeyMapAggregator </span>support and thus requires <span class='ec-lmtt-10'>KeySupport </span>to be
enabled.                                                                                                             </p></td>
</tr><tr id='TBL-4-18-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-18-1' style='white-space:normal; text-align:left;'>
<!-- l. 6358 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>Ps2MouseDxe</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-18-2' style='white-space:normal; text-align:left;'>
<!-- l. 6359 --><p class='noindent'>PS/2 mouse driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. Some very old laptop firmware may not include this
driver but it is necessary for the touchpad to work in UEFI graphical interfaces such as
<span class='ec-lmtt-10'>OpenCanopy</span>.                                                                                                        </p></td>
</tr><tr id='TBL-4-19-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-19-1' style='white-space:normal; text-align:left;'>
<!-- l. 6362 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenHfsPlus</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-19-2' style='white-space:normal; text-align:left;'>
<!-- l. 6363 --><p class='noindent'>HFS file system driver with bless support. This driver is an alternative to a closed source
<span class='ec-lmtt-10'>HfsPlus </span>driver  commonly  found  in  Apple  firmware.  While  it  is  feature  complete,  it  is
approximately 3 times slower and is yet to undergo a security audit.                              </p></td>
</tr><tr id='TBL-4-20-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-20-1' style='white-space:normal; text-align:left;'>
<!-- l. 6367 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>ResetNvramEntry</span></a><span class='ec-lmbx-10'>*</span>  </p></td><td class='td11' id='TBL-4-20-2' style='white-space:normal; text-align:left;'>
<!-- l. 6368 --><p class='noindent'><a href='#resetnvramentry'>OpenCore  plugin</a>  implementing  <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL </span>to  add  a  configurable  <span class='ec-lmtt-10'>Reset
</span><span class='ec-lmtt-10'>NVRAM </span>entry to the boot picker menu.                                                                       </p></td>
</tr><tr id='TBL-4-21-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-21-1' style='white-space:normal; text-align:left;'>
<!-- l. 6370 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>ToggleSipEntry</span></a><span class='ec-lmbx-10'>*</span>    </p></td><td class='td11' id='TBL-4-21-2' style='white-space:normal; text-align:left;'>
<!-- l. 6371 --><p class='noindent'><a href='#togglesipentry'>OpenCore plugin</a> implementing <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL </span>to add a configurable <span class='ec-lmtt-10'>Toggle SIP</span>
entry to the boot picker menu.                                                                                </p></td>
</tr><tr id='TBL-4-22-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-22-1' style='white-space:normal; text-align:left;'>
<!-- l. 6373 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>UsbMouseDxe</span></a><span class='ec-lmbx-10'>*</span>        </p></td><td class='td11' id='TBL-4-22-2' style='white-space:normal; text-align:left;'>
<!-- l. 6374 --><p class='noindent'>USB mouse driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. Some virtual machine firmware such as OVMF may
not include this driver but it is necessary for the mouse to work in UEFI graphical interfaces
such as <span class='ec-lmtt-10'>OpenCanopy</span>.                                                                                             </p></td>
</tr><tr id='TBL-4-23-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-23-1' style='white-space:normal; text-align:left;'>
<!-- l. 6377 --><p class='noindent'><a href='https://github.com/acidanthera/audk'><span class='ec-lmtt-10'>XhciDxe</span></a><span class='ec-lmbx-10'>*</span>             </p></td><td class='td11' id='TBL-4-23-2' style='white-space:normal; text-align:left;'>
<!-- l. 6378 --><p class='noindent'>XHCI USB controller support driver from <span class='ec-lmtt-10'>MdeModulePkg</span>. This driver is included in most
types of firmware starting with the Sandy Bridge generation. For earlier firmware or legacy
systems, it may be used to support external USB 3.0 PCI cards.                                    </p></td>
</tr><tr id='TBL-4-25-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-25-1' style='white-space:normal; text-align:left;'>
<!-- l. 6381 --><p class='noindent'>                  </p></td>
</tr><tr id='TBL-4-26-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-26-1' style='white-space:normal; text-align:left;'>
<!-- l. 6381 --><p class='noindent'>                  </p></td>
</tr><tr id='TBL-4-27-' style='vertical-align:baseline;'><td class='td11' id='TBL-4-27-1' style='white-space:normal; text-align:left;'>                  </td><td class='td11' id='TBL-4-27-2' style='white-space:normal; text-align:left;'>
</td></tr>
</table></div>
<!-- l. 6383 --><p class='noindent'>Driver marked with <span class='ec-lmbx-10'>* </span>are bundled with OpenCore. To compile the drivers from UDK (EDK II) the same command used for
OpenCore compilation can be taken, but choose a corresponding package: </p><!-- l. 6386 -->
<pre class='lstlisting' id='listing-15'><span class='label'><a id='x1-66002r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>git</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>clone </span><span class='ec-lmtt-10'>https://github.com/acidanthera/audk </span><span class='ec-lmtt-10'>UDK</span> 
</span><span class='label'><a id='x1-66003r2'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>cd</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>UDK</span> 
</span><span class='label'><a id='x1-66004r3'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>source</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>edksetup.sh</span> 
</span><span class='label'><a id='x1-66005r4'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>make</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-C </span><span class='ec-lmtt-10'>BaseTools</span> 
</span><span class='label'><a id='x1-66006r5'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>build</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-a </span><span class='ec-lmtt-10'>X64 </span><span class='ec-lmtt-10'>-b </span><span class='ec-lmtt-10'>RELEASE </span><span class='ec-lmtt-10'>-t </span><span class='ec-lmtt-10'>XCODE5 </span><span class='ec-lmtt-10'>-p </span><span class='ec-lmtt-10'>FatPkg/FatPkg.dsc</span> 
</span><span class='label'><a id='x1-66007r6'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>build</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-a </span><span class='ec-lmtt-10'>X64 </span><span class='ec-lmtt-10'>-b </span><span class='ec-lmtt-10'>RELEASE </span><span class='ec-lmtt-10'>-t </span><span class='ec-lmtt-10'>XCODE5 </span><span class='ec-lmtt-10'>-p </span><span class='ec-lmtt-10'>MdeModulePkg/MdeModulePkg.dsc</span></span></pre>
<!-- l. 6395 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='tools-and-applications'><span class='titlemark'>11.3   </span> <a id='x1-6700011.3'></a>Tools and Applications</h4>
<!-- l. 6397 --><p class='noindent'>Standalone tools may help to debug firmware and hardware. Some of the known tools are listed below. While some tools can be
launched from within OpenCore (Refer to the <a href='#x1-43014x7'>Tools</a> subsection for more details), most should be run separately either directly
or from <span class='ec-lmtt-10'>Shell</span>.
</p><!-- l. 6401 --><p class='noindent'>To boot into OpenShell or any other tool directly save <span class='ec-lmtt-10'>OpenShell.efi </span>under the name of <span class='ec-lmtt-10'>EFI\BOOT\BOOTX64.EFI </span>on a FAT32
partition. It is typically unimportant whether the partition scheme is <span class='ec-lmtt-10'>GPT </span>or <span class='ec-lmtt-10'>MBR</span>.
</p><!-- l. 6406 --><p class='noindent'>While the previous approach works both on Macs and other computers, an alternative Mac-only approach to bless the tool on
an HFS+ or APFS volume:
                                                                                                  
                                                                                                  
</p>
<!-- l. 6410 -->
<p id='-blessing-tool'><a id='x1-67001r3'></a>
<a id='x1-67002'></a>
</p><pre class='lstlisting' id='listing-16'><span class='label'><a id='x1-67003r1'></a></span><span style='color:#000000'><span class='ec-lmtk-10'>sudo</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>bless </span><span class='ec-lmtt-10'>--verbose </span><span class='ec-lmtt-10'>--file </span><span class='ec-lmtt-10'>/Volumes/VOLNAME/DIR/OpenShell.efi </span><span class='ec-lmtt-10'>\</span> 
</span><span class='label'><a id='x1-67004r2'></a></span><span style='color:#000000'>  <span class='ec-lmtt-10'>--folder </span><span class='ec-lmtt-10'>/Volumes/VOLNAME/DIR/ </span><span class='ec-lmtt-10'>--setBoot</span></span></pre>
<figcaption class='caption'><span class='id'>Listing 3: </span><span class='content'>Blessing tool</span></figcaption><!-- tex4ht:label?: x1-67004r11.3  -->
<!-- l. 6415 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: <span class='ec-lmtt-10'>/System/Library/CoreServices/BridgeVersion.bin </span>should be copied to <span class='ec-lmtt-10'>/Volumes/VOLNAME/DIR</span>.
<br class='newline' /><span class='ec-lmri-10'>Note 2</span>: To be able to use the <span class='ec-lmtt-10'>bless </span>command, <a href='https://developer.apple.com/library/archive/documentation/Security/Conceptual/System_Integrity_Protection_Guide/ConfiguringSystemIntegrityProtection/ConfiguringSystemIntegrityProtection.html'>disabling System Integrity Protection</a> is necessary. <br class='newline' /><span class='ec-lmri-10'>Note 3</span>: To be able to boot <a href='https://support.apple.com/HT208330'>Secure Boot</a> might be disabled if present.
</p><!-- l. 6422 --><p class='noindent'>Some of the known tools are listed below (builtin tools are marked with <span class='ec-lmbx-10'>*</span>):
</p>
<div class='tabular'> <table class='tabular' id='TBL-5'><colgroup id='TBL-5-1g'><col id='TBL-5-1' /><col id='TBL-5-2' /></colgroup><tr id='TBL-5-1-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-1-1' style='white-space:normal; text-align:left;'><!-- l. 6425 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>BootKicker</span></a><span class='ec-lmbx-10'>*</span>         </p></td><td class='td11' id='TBL-5-1-2' style='white-space:normal; text-align:left;'><!-- l. 6426 --><p class='noindent'>Enter Apple BootPicker menu (exclusive for Macs with compatible GPUs).                      </p></td>
</tr><tr id='TBL-5-2-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-2-1' style='white-space:normal; text-align:left;'><!-- l. 6427 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>ChipTune</span></a><span class='ec-lmbx-10'>*</span>             </p></td><td class='td11' id='TBL-5-2-2' style='white-space:normal; text-align:left;'><!-- l. 6428 --><p class='noindent'>Test BeepGen protocol and generate audio signals of different style and length.                </p></td>
</tr><tr id='TBL-5-3-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-3-1' style='white-space:normal; text-align:left;'><!-- l. 6429 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>CleanNvram</span></a><span class='ec-lmbx-10'>*</span>          </p></td><td class='td11' id='TBL-5-3-2' style='white-space:normal; text-align:left;'><!-- l. 6430 --><p class='noindent'>Reset NVRAM alternative bundled as a standalone tool.                                              </p></td>
</tr><tr id='TBL-5-4-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-4-1' style='white-space:normal; text-align:left;'><!-- l. 6431 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>CsrUtil</span></a><span class='ec-lmbx-10'>*</span>              </p></td><td class='td11' id='TBL-5-4-2' style='white-space:normal; text-align:left;'><!-- l. 6432 --><p class='noindent'>Simple implementation of SIP-related features of Apple <span class='ec-lmtt-10'>csrutil</span>.                                   </p></td>
</tr><tr id='TBL-5-5-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-5-1' style='white-space:normal; text-align:left;'><!-- l. 6433 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>GopStop</span></a><span class='ec-lmbx-10'>*</span>              </p></td><td class='td11' id='TBL-5-5-2' style='white-space:normal; text-align:left;'><!-- l. 6434 --><p class='noindent'>Test GraphicsOutput protocol with a <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Application/GopStop'>simple scenario</a>.                                                  </p></td>
</tr><tr id='TBL-5-6-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-6-1' style='white-space:normal; text-align:left;'><!-- l. 6436 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>KeyTester</span></a><span class='ec-lmbx-10'>*</span>            </p></td><td class='td11' id='TBL-5-6-2' style='white-space:normal; text-align:left;'><!-- l. 6437 --><p class='noindent'>Test keyboard input in <span class='ec-lmtt-10'>SimpleText </span>mode.                                                                 </p></td>
</tr><tr id='TBL-5-7-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-7-1' style='white-space:normal; text-align:left;'><!-- l. 6438 --><p class='noindent'><a href='https://www.memtest86.com'><span class='ec-lmtt-10'>MemTest86</span></a>          </p></td><td class='td11' id='TBL-5-7-2' style='white-space:normal; text-align:left;'><!-- l. 6439 --><p class='noindent'>Memory testing utility.                                                                                          </p></td>
</tr><tr id='TBL-5-8-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-8-1' style='white-space:normal; text-align:left;'><!-- l. 6440 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenControl</span></a><span class='ec-lmbx-10'>*</span>         </p></td><td class='td11' id='TBL-5-8-2' style='white-space:normal; text-align:left;'><!-- l. 6441 --><p class='noindent'>Unlock and lock back NVRAM protection for other tools to be able to get full NVRAM
access when launching from OpenCore.                                                                     </p></td>
</tr><tr id='TBL-5-9-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-9-1' style='white-space:normal; text-align:left;'><!-- l. 6443 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>OpenShell</span></a><span class='ec-lmbx-10'>*</span>            </p></td><td class='td11' id='TBL-5-9-2' style='white-space:normal; text-align:left;'><!-- l. 6444 --><p class='noindent'>OpenCore-configured <a href='http://github.com/tianocore/edk2'><span class='ec-lmtt-10'>UEFI Shell</span></a> for compatibility with a broad range of firmware.          </p></td>
</tr><tr id='TBL-5-10-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-10-1' style='white-space:normal; text-align:left;'><!-- l. 6446 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>PavpProvision</span></a>      </p></td><td class='td11' id='TBL-5-10-2' style='white-space:normal; text-align:left;'><!-- l. 6447 --><p class='noindent'>Perform EPID provisioning (requires certificate data configuration).                               </p></td>
</tr><tr id='TBL-5-11-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-11-1' style='white-space:normal; text-align:left;'><!-- l. 6448 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>ResetSystem</span></a><span class='ec-lmbx-10'>*</span>         </p></td><td class='td11' id='TBL-5-11-2' style='white-space:normal; text-align:left;'><!-- l. 6449 --><p class='noindent'>Utility to perform system reset. Takes reset type as an argument: <span class='ec-lmtt-10'>coldreset</span>, <span class='ec-lmtt-10'>firmware</span>,
<span class='ec-lmtt-10'>shutdown</span>, <span class='ec-lmtt-10'>warmreset</span>. Defaults to <span class='ec-lmtt-10'>coldreset</span>.                                                           </p></td>
</tr><tr id='TBL-5-12-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-12-1' style='white-space:normal; text-align:left;'><!-- l. 6452 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>RtcRw</span></a><span class='ec-lmbx-10'>*</span>                 </p></td><td class='td11' id='TBL-5-12-2' style='white-space:normal; text-align:left;'><!-- l. 6453 --><p class='noindent'>Utility to read and write RTC (CMOS) memory.                                                        </p></td>
</tr><tr id='TBL-5-13-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-13-1' style='white-space:normal; text-align:left;'><!-- l. 6454 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>ControlMsrE2</span></a><span class='ec-lmbx-10'>*</span>       </p></td><td class='td11' id='TBL-5-13-2' style='white-space:normal; text-align:left;'><!-- l. 6455 --><p class='noindent'>Check <span class='ec-lmtt-10'>CFG Lock </span>(MSR <span class='ec-lmtt-10'>0xE2 </span>write protection) consistency across all cores and change such
hidden options on selected platforms.                                                                       </p></td>
</tr><tr id='TBL-5-14-' style='vertical-align:baseline;'><td class='td11' id='TBL-5-14-1' style='white-space:normal; text-align:left;'><!-- l. 6457 --><p class='noindent'><a href='https://github.com/acidanthera/OpenCorePkg'><span class='ec-lmtt-10'>TpmInfo</span></a><span class='ec-lmbx-10'>*</span>              </p></td><td class='td11' id='TBL-5-14-2' style='white-space:normal; text-align:left;'><!-- l. 6458 --><p class='noindent'>Check Intel PTT (Platform Trust Technology) capability on the platform, which allows using
fTPM 2.0 if enabled. The tool does not check whether fTPM 2.0 is actually enabled.         </p></td>
</tr></table>                                                                                                   </div>
<!-- l. 6463 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='opencanopy'><span class='titlemark'>11.4   </span> <a id='x1-6800011.4'></a>OpenCanopy</h4>
<!-- l. 6465 --><p class='noindent'>OpenCanopy is a graphical OpenCore user interface that runs in <span class='ec-lmtt-10'>External PickerMode </span>and relies on <a href='https://github.com/acidanthera/OpenCorePkg'>OpenCorePkg</a>
<span class='ec-lmtt-10'>OcBootManagementLib </span>similar to the builtin text interface.
</p><!-- l. 6470 --><p class='noindent'>OpenCanopy requires graphical resources located in <span class='ec-lmtt-10'>Resources </span>directory to run. Sample resources (fonts and
images) can be found in <a href='https://github.com/acidanthera/OcBinaryData'>OcBinaryData repository</a>. Customised icons can be found over the internet (e.g. <a href='https://github.com/blackosx/OpenCanopyIcons'>here</a> or
<a href='https://applelife.ru/threads/kastomizacija-opencanopy.2945020/'>there</a>).
</p><!-- l. 6475 --><p class='noindent'>OpenCanopy provides full support for <span class='ec-lmtt-10'>PickerAttributes </span>and offers a configurable builtin icon set. The chosen icon set may
depend on the <span class='ec-lmtt-10'>DefaultBackgroundColor </span>variable value. Refer to <span class='ec-lmtt-10'>PickerVariant </span>for more details.
</p><!-- l. 6479 --><p class='noindent'>Predefined icons are saved in the <span class='ec-lmtt-10'>PickerVariant</span>-derived subdirectory of the <span class='ec-lmtt-10'>\EFI\OC\Resources\Image </span>directory. A full list
of supported icons (in <span class='ec-lmtt-10'>.icns </span>format) is provided below. When optional icons are missing, the closest available icon will be
used. External entries will use <span class='ec-lmtt-10'>Ext</span>-prefixed icon if available (e.g. <span class='ec-lmtt-10'>OldExtHardDrive.icns</span>).
</p><!-- l. 6485 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: In the following all dimensions are normative for the 1x scaling level and shall be scaled accordingly for other
levels.
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>Cursor </span>— Mouse cursor (mandatory, up to 144x144).
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Selected </span>— Selected item (mandatory, 144x144).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Selector </span>— Selecting item (mandatory, up to 144x40).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SetDefault </span>— Selecting default (mandatory, up to 144x40; must be same width as <span class='ec-lmtt-10'>Selector</span>).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Left </span>— Scrolling left (mandatory, 40x40).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Right </span>— Scrolling right (mandatory, 40x40).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>HardDrive </span>— Generic OS (mandatory, 128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Background </span>— Centred background image.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Apple </span>— Apple OS (128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>AppleRecv </span>— Apple Recovery OS (128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>AppleTM </span>— Apple Time Machine (128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Windows </span>— Windows (128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Other </span>— Custom entry (see <span class='ec-lmtt-10'>Entries</span>, 128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>ResetNVRAM </span>— Reset NVRAM system action or tool (128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Shell </span>— Entry with UEFI Shell name for e.g. <span class='ec-lmtt-10'>OpenShell </span>(128x128).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Tool </span>— Any other tool (128x128).</li></ul>
<!-- l. 6508 --><p class='noindent'>Predefined labels are saved in the <span class='ec-lmtt-10'>\EFI\OC\Resources\Label </span>directory. Each label has <span class='ec-lmtt-10'>.lbl </span>or <span class='ec-lmtt-10'>.l2x </span>suffix to represent the
scaling level. Full list of labels is provided below. All labels are mandatory.
</p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>EFIBoot </span>— Generic OS.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Apple </span>— Apple OS.
     </li>
                                                                                                  
                                                                                                  
     <li class='itemize'><span class='ec-lmtt-10'>AppleRecv </span>— Apple Recovery OS.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>AppleTM </span>— Apple Time Machine.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Windows </span>— Windows.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Other </span>— Custom entry (see <span class='ec-lmtt-10'>Entries</span>).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>ResetNVRAM </span>— Reset NVRAM system action or tool.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SIPDisabled </span>— Toggle SIP tool with SIP disabled.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SIPEnabled </span>— Toggle SIP tool with SIP enabled.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Shell </span>— Entry with UEFI Shell name (e.g. <span class='ec-lmtt-10'>OpenShell</span>).
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>Tool </span>— Any other tool.</li></ul>
<!-- l. 6528 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: All labels must have a height of exactly 12 px. There is no limit for their width.
</p><!-- l. 6530 --><p class='noindent'>Label and icon generation can be performed with bundled utilities: <span class='ec-lmtt-10'>disklabel </span>and <span class='ec-lmtt-10'>icnspack</span>. Font is Helvetica 12 pt times
scale factor.
</p><!-- l. 6533 --><p class='noindent'>Font format corresponds to <a href='https://www.angelcode.com/products/bmfont'>AngelCode binary BMF</a>. While there are many utilities to generate font files, currently it is
recommended to use <a href='https://github.com/danpla/dpfontbaker'>dpFontBaker</a> to generate bitmap font (<a href='https://github.com/danpla/dpfontbaker/pull/1'>using CoreText produces best results</a>) and <a href='https://github.com/usr-sse2/fonverter'>fonverter</a> to export it to
binary format.
</p><!-- l. 6539 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='openruntime'><span class='titlemark'>11.5   </span> <a id='x1-6900011.5'></a>OpenRuntime</h4>
<!-- l. 6541 --><p class='noindent'><span class='ec-lmtt-10'>OpenRuntime </span>is an OpenCore plugin implementing <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol. This protocol implements multiple features
required for OpenCore that are otherwise not possible to implement in OpenCore itself as they are needed to work in runtime,
i.e. during operating system functioning. Feature highlights:
</p>
     <ul class='itemize1'>
     <li class='itemize'>NVRAM   namespaces,   allowing   to   isolate   operating   systems   from   accessing   select   variables   (e.g.
     <span class='ec-lmtt-10'>RequestBootVarRouting </span>or <span class='ec-lmtt-10'>ProtectSecureBoot</span>).
     </li>
     <li class='itemize'>Read-only and write-only NVRAM variables, enhancing the security of OpenCore, Lilu, and Lilu plugins, such
     as VirtualSMC, which implements <span class='ec-lmtt-10'>AuthRestart </span>support.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'>NVRAM isolation, allowing to protect all variables from being written from an untrusted operating system (e.g.
     <span class='ec-lmtt-10'>DisableVariableWrite</span>).
     </li>
     <li class='itemize'>UEFI   Runtime   Services   memory   protection   management   to   workaround   read-only   mapping   (e.g.
     <span class='ec-lmtt-10'>EnableWriteUnprotector</span>).</li></ul>
<!-- l. 6557 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='openlinuxboot'><span class='titlemark'>11.6   </span> <a id='x1-7000011.6'></a>OpenLinuxBoot</h4>
<!-- l. 6559 --><p class='noindent'>OpenLinuxBoot is an OpenCore plugin implementing <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL</span>. It aims to automatically detect and boot
most Linux distros without additional configuration.
</p><!-- l. 6562 --><p class='noindent'>Usage is as follows:
</p>
     <ul class='itemize1'>
     <li class='itemize'>Add <span class='ec-lmtt-10'>OpenLinuxBoot.efi </span>and also typically (see below) <span class='ec-lmtt-10'>ext4_x64.efi </span>to the <span class='ec-lmtt-10'>config.plist Drivers </span>section.
     </li>
     <li class='itemize'>Make sure <span class='ec-lmtt-10'>RequestBootVarRouting </span>and <span class='ec-lmtt-10'>LauncherOption </span>are enabled in <span class='ec-lmtt-10'>config.plist</span>; it is also recommended
     to enable <span class='ec-lmtt-10'>HideAuxiliary </span>in order to hide older Linux kernels except when required (they are added as auxiliary
     entries and so may then be shown by pressing the <span class='ec-lmtt-10'>Spacebar </span>key in the OpenCore boot menu).
     </li>
     <li class='itemize'>Install Linux as normal if this has not been done earlier – OpenLinuxBoot is not involved in this stage.
     </li>
     <li class='itemize'>Reboot into OpenCore: the installed Linux distribution should just appear and boot directly from OpenCore
     when selected, which it does without chainloading via GRUB.</li></ul>
<!-- l. 6576 --><p class='noindent'>If OpenCore has already been manually set up to boot Linux, e.g. via <span class='ec-lmtt-10'>BlessOverride </span>or via <span class='ec-lmtt-10'>Entries </span>then then these settings
may be removed so that the Linux distribution is not displayed twice in the boot menu.
</p><!-- l. 6579 --><p class='noindent'>It is recommended to install Linux with its default bootloader, even though this will not be actively used when booting via
OpenLinuxBoot. This is because OpenLinuxBoot has to detect the correct kernel options to use, and does so by looking in files
left by the default bootloader. If no bootloader was installed (or these options cannot be found) booting is still
possible, but the correct boot options must be manually specified before OpenLinuxBoot will attempt to start the
distro.
</p><!-- l. 6585 --><p class='noindent'>OpenLinuxBoot typically requires filesystem drivers that are not available in firmware, such as EXT4 and BTRFS drivers.
These drivers can be obtained from external sources. Drivers tested in basic scenarios can be downloaded from <a href='https://github.com/acidanthera/OcBinaryData'>OcBinaryData</a>.
Be aware that these drivers are not tested for reliability in all scenarious, nor did they undergo tamper-resistance testing,
therefore they may carry potential security or data-loss risks.
</p><!-- l. 6591 --><p class='noindent'>Most Linux distros require the <a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>ext4_x64</span></a> driver, a few may require the <a href='https://github.com/acidanthera/OcBinaryData'><span class='ec-lmtt-10'>btrfs_x64</span></a> driver, and a few may require no additional
file system driver: it depends on the filesystem of the boot partition of the installed distro, and on what filesystems are already
supported by the system’s firmware. LVM is not currently supported - this is because it is not believed that there is currently a
stand-alone UEFI LVM filesystem driver.
</p><!-- l. 6597 --><p class='noindent'>Be aware of the <span class='ec-lmtt-10'>SyncRuntimePermissions </span>quirk, which may need to be set to avoid early boot failure (typically halting with a
black screen) of the Linux kernel, due to a firmware bug of some firmware released after 2017. When present and not mitigated
                                                                                                  
                                                                                                  
by this quirk, this affects booting via OpenCore with or without OpenLinuxBoot.
</p><!-- l. 6602 --><p class='noindent'>After installing OpenLinuxBoot, it is recommended to compare the options shown in the OpenCore debug log
when booting (or attempting to boot) a given distro against the options seen using the shell command <span class='ec-lmtt-10'>cat
</span><span class='ec-lmtt-10'>/proc/cmdline </span>when the same distro has been booted via its native bootloader. In general (for safety and security of the
running distro) these options should match, and if they do not it is recommended to use the driver arguments
below (in particular <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO</span>, <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RW</span>, <span class='ec-lmtt-10'>autoopts:{PARTUUID} </span>and <span class='ec-lmtt-10'>autoopts</span>) to modify
the options as required. Note however that the following differences are normal and do not need to be fixed:
</p>
     <ul class='itemize1'>
     <li class='itemize'>If  the  default  bootloader  is  GRUB  then  the  options  generated  by  OpenLinuxBoot  will  not  contain  a
     <span class='ec-lmtt-10'>BOOT_IMAGE=... </span>value where the GRUB options do, and will contain an <span class='ec-lmtt-10'>initrd=... </span>value where the GRUB
     options do not.
     </li>
     <li class='itemize'>OpenLinuxBoot uses <span class='ec-lmtt-10'>PARTUUID </span>rather than filesystem <span class='ec-lmtt-10'>UUID </span>to identify the location of <span class='ec-lmtt-10'>initrd</span>, this is by design
     as UEFI filesystem drivers do not make Linux filesystem <span class='ec-lmtt-10'>UUID </span>values available.
     </li>
     <li class='itemize'>Less important graphics handover options (such as discussed in the Ubuntu example given in <span class='ec-lmtt-10'>autoopts </span>below)
     will not match exactly, this is not important as long as distro boots successfully.</li></ul>
<!-- l. 6625 --><p class='noindent'>If using OpenLinuxBoot with Secure Boot, users may wish to use the <span class='ec-lmtt-10'>shim-to-cert.tool </span>included in OpenCore utilities,
which can be used to extract the public key needed to boot a distro’s kernels directly, as done when using OpenCore with
OpenLinuxBoot, rather than via GRUB shim. For non-GRUB distros, the required public key must be found by user
research.
</p><!-- l. 6629 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='configuration1'><span class='titlemark'>11.6.1   </span> <a id='x1-7100011.6.1'></a>Configuration</h5>
<!-- l. 6631 --><p class='noindent'>The default parameter values should work well with no changes under most circumstances, but if required the following options
for the driver may be specified in <span class='ec-lmtt-10'>UEFI/Drivers/Arguments</span>:
</p>
     <ul class='itemize1'>
     <li class='itemize'>
     <!-- l. 6636 --><p class='noindent'><span class='ec-lmtt-10'>flags </span>- Default: all flags are set except the following: </p>
         <ul class='itemize2'>
         <li class='itemize'><span class='ec-lmtt-10'>LINUX_BOOT_ADD_RW</span>,
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>LINUX_BOOT_LOG_VERBOSE </span>and
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>LINUX_BOOT_ADD_DEBUG_INFO</span>.</li></ul>
     <!-- l. 6645 --><p class='noindent'>Available flags are:
</p>
         <ul class='itemize2'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000001 </span>(bit <span class='ec-lmtt-10'>0</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_SCAN_ESP</span>, Allows scanning for entries on EFI System Partition.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000002 </span>(bit <span class='ec-lmtt-10'>1</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_SCAN_XBOOTLDR</span>, Allows scanning for entries on Extended Boot Loader
         Partition.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000004 </span>(bit  <span class='ec-lmtt-10'>2</span>)  —  <span class='ec-lmtt-10'>LINUX_BOOT_SCAN_LINUX_ROOT</span>,  Allows  scanning  for  entries  on  Linux  Root
         filesystems.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000008 </span>(bit  <span class='ec-lmtt-10'>3</span>)  —  <span class='ec-lmtt-10'>LINUX_BOOT_SCAN_LINUX_DATA</span>,  Allows  scanning  for  entries  on  Linux  Data
         filesystems.
         </li>
         <li class='itemize'>
         <!-- l. 6657 --><p class='noindent'><span class='ec-lmtt-10'>0x00000080 </span>(bit <span class='ec-lmtt-10'>7</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_SCAN_OTHER</span>, Allows scanning for entries on file systems not matched
         by any of the above.
         </p><!-- l. 6660 --><p class='noindent'>The following notes apply to all of the above options:
         </p><!-- l. 6662 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Apple filesystems APFS and HFS are never scanned.
         </p><!-- l. 6665 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Regardless of the above flags, a file system must first be allowed by <span class='ec-lmtt-10'>Misc/Security/ScanPolicy</span>
         before it can be seen by OpenLinuxBoot or any other <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL </span>driver.
         </p><!-- l. 6670 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: It is recommended to enable scanning <span class='ec-lmtt-10'>LINUX_ROOT </span>and <span class='ec-lmtt-10'>LINUX_DATA </span>in both OpenLinuxBoot flags
         and <span class='ec-lmtt-10'>Misc/Security/ScanPolicy </span>in order to be sure to detect all valid Linux installs, since Linux boot
         filesystems are very often marked as <span class='ec-lmtt-10'>LINUX_DATA</span>.
         </p></li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000100 </span>(bit <span class='ec-lmtt-10'>8</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_ALLOW_AUTODETECT</span>, If set allows autodetecting and linking <span class='ec-lmtt-10'>vmlinuz*</span>
         and <span class='ec-lmtt-10'>init* </span>ramdisk files when <span class='ec-lmtt-10'>loader/entries </span>files are not found.
         </li>
         <li class='itemize'>
         <!-- l. 6678 --><p class='noindent'><span class='ec-lmtt-10'>0x00000200 </span>(bit <span class='ec-lmtt-10'>9</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_USE_LATEST</span>, When a Linux entry generated by OpenLinuxBoot is
         selected as the default boot entry in OpenCore, automatically switch to the latest kernel when a new version
         is installed.
         </p><!-- l. 6682 --><p class='noindent'>When this option is set, an internal menu entry id is shared between kernel versions from the same install
         of Linux. Linux boot options are always sorted highest kernel version first, so this means that the latest
         kernel version of the same install always shows as the default, with this option set.
         </p><!-- l. 6686 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option is recommended on all systems.
         </p></li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000400 </span>(bit <span class='ec-lmtt-10'>10</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO</span>, This option applies to autodetected Linux only (i.e. not to
         BLSpec or Fedora-style distributions which have <span class='ec-lmtt-10'>/loader/entries/*.conf </span>files). Some distributions run a
         filesystem check on loading which requires the root filesystem to initially be mounted read-only via the <span class='ec-lmtt-10'>ro</span>
         kernel option, which requires this option to be added to the autodetected options. Set this bit to add this
         option on autodetected distros; should be harmless but very slightly slow down boot time (due to requried
         remount as read-write) on distros which do not require it. When there are multiple distros and it is required
         to specify this option for specific distros only, use <span class='ec-lmtt-10'>autoopts:{PARTUUID}+=ro </span>to manually add the option
         where required, instead of using this flag.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000800 </span>(bit <span class='ec-lmtt-10'>11</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RW</span>, Like <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO</span>, this option applies to autodetected
         Linux  only.  It  is  not  required  for  most  distros  (which  usually  require  either  <span class='ec-lmtt-10'>ro </span>or  nothing  to  be
         added  to  detected  boot  options),  but  is  required  on  some  Arch-derived  distros,  e.g.  EndeavourOS.
         When there are multiple distros and it is required to specify this option for specific distros only, use
         <span class='ec-lmtt-10'>autoopts:{PARTUUID}+=rw </span>to manually add the option where required, instead of using this flag. If this
         option and <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO </span>are both specified, only this option is applied and <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO </span>is
         ignored.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00002000      </span>(bit         <span class='ec-lmtt-10'>13</span>)         —         <span class='ec-lmtt-10'>LINUX_BOOT_ALLOW_CONF_AUTO_ROOT</span>,         In         some
         instances of <span class='ec-lmtt-10'>BootLoaderSpecByDefault </span>in combination with <span class='ec-lmtt-10'>ostree</span>, the <span class='ec-lmtt-10'>/loader/entries/*.conf </span>files
         do not specify a required <span class='ec-lmtt-10'>root=... </span>kernel option – it is added by GRUB. If this bit is set and this situation
         is detected, then automatically add this option. (Required for example by Endless OS.)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00004000 </span>(bit <span class='ec-lmtt-10'>14</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_LOG_VERBOSE</span>, Add additional debug log info about files encountered
         and autodetect options added while scanning for Linux boot entries.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00008000 </span>(bit <span class='ec-lmtt-10'>15</span>) — <span class='ec-lmtt-10'>LINUX_BOOT_ADD_DEBUG_INFO</span>, Adds a human readable file system type, followed
         by the first eight characters of the partition’s unique partition uuid, to each generated entry name. Can
         help with debugging the origin of entries generated by the driver when there are multiple Linux installs on
         one system.</li></ul>
     <!-- l. 6723 --><p class='noindent'>Flag values can be specified in hexadecimal beginning with <span class='ec-lmtt-10'>0x </span>or in decimal, e.g. <span class='ec-lmtt-10'>flags=0x80 </span>or <span class='ec-lmtt-10'>flags=128</span>. It is also
     possible to specify flags to add or remove, using syntax such as <span class='ec-lmtt-10'>flags+=0xC000 </span>to add all debugging options or
     <span class='ec-lmtt-10'>flags-=0x400 </span>to remove the <span class='ec-lmtt-10'>LINUX_BOOT_ADD_RO </span>option.
     </p></li>
     <li class='itemize'>
     <!-- l. 6728 --><p class='noindent'><span class='ec-lmtt-10'>autoopts:{PARTUUID}[+]="{options}" </span>- Default: not set.
     </p><!-- l. 6730 --><p class='noindent'>Allows manually specifying kernel options to use in autodetect mode for a given partition only. Replace the text
     <span class='ec-lmtt-10'>{PARTUUID} </span>with the specific partition UUID on which the kernels are stored (in normal layout, the partition which
     contains <span class='ec-lmtt-10'>/boot</span>), e.g. <span class='ec-lmtt-10'>autoopts:11223344-5566-7788-99aa-bbccddeeff00+="vt.handoff=7"</span>. If specified with <span class='ec-lmtt-10'>+= </span>then
     these options are used in addition to any autodetected options, if specified with <span class='ec-lmtt-10'>= </span>they are used instead. Used for
     autodetected Linux only – values specified here are never used for entries created from <span class='ec-lmtt-10'>/loader/entries/*.conf </span>files.
     </p><!-- l. 6739 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The <span class='ec-lmtt-10'>PARTUUID </span>value to be specified here is typically the same as the <span class='ec-lmtt-10'>PARTUUID </span>seen in <span class='ec-lmtt-10'>root=PARTUUID=... </span>in the
     Linux kernel boot options (view using <span class='ec-lmtt-10'>cat /proc/cmdline</span>). Alternatively, and for more advanced scenarios, it is possible
     to examine how the distro’s partitions are mounted using the Linux <span class='ec-lmtt-10'>mount </span>command, and then find out the
     partuuid of relevant mounted partitions by examining the output of <span class='ec-lmtt-10'>ls -l /dev/disk/by-partuuid</span>.
     </p></li>
     <li class='itemize'>
     <!-- l. 6746 --><p class='noindent'><span class='ec-lmtt-10'>autoopts[+]="{options}" </span>- Default: None specified.
     </p><!-- l. 6748 --><p class='noindent'>Allows manually specifying kernel options to use in autodetect mode. The alternative format <span class='ec-lmtt-10'>autoopts:{PARTUUID} </span>is
     more suitable where there are multiple distros, but <span class='ec-lmtt-10'>autoopts </span>with no PARTUUID required may be more convenient for
     just one distro. If specified with <span class='ec-lmtt-10'>+= </span>then these are used in addition to autodetected options, if specified with <span class='ec-lmtt-10'>= </span>they are
     used instead. Used for autodetected Linux only – values specified here are never used for entries created from
     <span class='ec-lmtt-10'>/loader/entries/*.conf </span>files.
     </p><!-- l. 6756 --><p class='noindent'>As example usage, it is possible to use <span class='ec-lmtt-10'>+= </span>format to add a <span class='ec-lmtt-10'>vt.handoff </span>options, such as <span class='ec-lmtt-10'>autopts+="vt.handoff=7" </span>or
     <span class='ec-lmtt-10'>autopts+="vt.handoff=3" </span>(check <span class='ec-lmtt-10'>cat /proc/cmdline </span>when booted via the distro’s default bootloader) on Ubuntu and
     related distros, in order to add the <span class='ec-lmtt-10'>vt.handoff </span>option to the auto-detected GRUB defaults, and avoid a flash of text
     showing before the distro splash screen. </p></li></ul>
<!-- l. 6764 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='additional-information'><span class='titlemark'>11.6.2   </span> <a id='x1-7200011.6.2'></a>Additional information</h5>
<!-- l. 6766 --><p class='noindent'>OpenLinuxBoot can detect the <span class='ec-lmtt-10'>loader/entries/*.conf </span>files created according to the <a href='https://systemd.io/BOOT_LOADER_SPECIFICATION/'>Boot Loader Specification</a> or the closely
related <a href='https://fedoraproject.org/wiki/Changes/BootLoaderSpecByDefault'>systemd BootLoaderSpecByDefault</a>. The former is specific to systemd-boot and is used by Arch Linux, the latter
applies to most Fedora-related distros including Fedora itself, RHEL and variants.
                                                                                                  
                                                                                                  
</p><!-- l. 6772 --><p class='noindent'>Where the above files are not present, OpenLinuxBoot can autodetect and boot <span class='ec-lmtt-10'>{boot}/vmlinuz* </span>kernel files directly. It links
these automatically – based on the kernel version in the filename – to their associated <span class='ec-lmtt-10'>{boot}/init* </span>ramdisk files. This applies
to most Debian-related distros, including Debian itself, Ubuntu and variants.
</p><!-- l. 6777 --><p class='noindent'>When autodetecting in <span class='ec-lmtt-10'>/boot </span>as part of the root filesystem, OpenLinuxBoot looks in <span class='ec-lmtt-10'>/etc/default/grub </span>for kernel boot
options and <span class='ec-lmtt-10'>/etc/os-release </span>for the distro name. When autodetecting in a standalone boot partition (i.e. when <span class='ec-lmtt-10'>/boot </span>has its
own mount point), OpenLinuxBoot cannot autodetect kernel arguments and all kernel arguments except <span class='ec-lmtt-10'>initrd=... </span>must be
fully specified by hand using <span class='ec-lmtt-10'>autoopts=... </span>or <span class='ec-lmtt-10'>autoopts:{partuuid}=... </span>(<span class='ec-lmtt-10'>+= </span>variants of these options will not work, as these
only add additional arguments).
</p><!-- l. 6784 --><p class='noindent'>BootLoaderSpecByDefault (but not pure Boot Loader Specification) can expand GRUB variables in the <span class='ec-lmtt-10'>*.conf </span>files – and this
is used in practice in certain distros such as CentOS. In order to handle this correctly, when this situation is detected
OpenLinuxBoot extracts all variables from <span class='ec-lmtt-10'>{boot}/grub2/grubenv </span>and also any unconditionally set variables from
<span class='ec-lmtt-10'>{boot}/grub2/grub.cfg</span>, and then expands these where required in <span class='ec-lmtt-10'>*.conf </span>file entries.
</p><!-- l. 6790 --><p class='noindent'>The only currently supported method of starting Linux kernels relies on their being compiled with EFISTUB. This applies to
almost all modern distros, particularly those which use systemd. Note that most modern distros use systemd as their system
manager, even though most do not use systemd-boot as their bootloader.
</p><!-- l. 6795 --><p class='noindent'>systemd-boot users (probably almost exclusively Arch Linux users) should be aware that OpenLinuxBoot does not support the
systemd-boot–specific <a href='https://systemd.io/BOOT_LOADER_INTERFACE/'>Boot Loader Interface</a>; therefore <span class='ec-lmtt-10'>efibootmgr </span>rather than <span class='ec-lmtt-10'>bootctl </span>must be used for any low-level Linux
command line interaction with the boot menu.
</p><!-- l. 6800 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='other-boot-entry-protocol-drivers'><span class='titlemark'>11.7   </span> <a id='x1-7300011.7'></a>Other Boot Entry Protocol drivers</h4>
<!-- l. 6802 --><p class='noindent'>In addition to the <a href='#openlinuxboot'>OpenLinuxBoot</a> plugin, the following <span class='ec-lmtt-10'>OC_BOOT_ENTRY_PROTOCOL </span>plugins are made available to add optional,
configurable boot entries to the OpenCore boot picker.
</p><!-- l. 6805 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='resetnvramentry'><span class='titlemark'>11.7.1   </span> <a id='x1-7400011.7.1'></a>ResetNvramEntry</h5>
<!-- l. 6807 --><p class='noindent'>Adds a menu entry which resets NVRAM and immediately restarts. Additionally adds support for hotkey <span class='ec-lmtt-10'>CMD+OPT+P+R </span>to
perform the same action. Note that on some combinations of firmware and drivers, the <span class='ec-lmtt-10'>TakeoffDelay </span>option must be
configured in order for this and other builtin hotkeys to be reliably detected.
</p><!-- l. 6812 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: It is known that some Lenovo laptops have a firmware bug, which makes them unbootable after performing NVRAM
reset. Refer to <a href='https://github.com/acidanthera/bugtracker/issues/995'>acidanthera/bugtracker#995</a> for details.
</p><!-- l. 6817 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: If <span class='ec-lmtt-10'>LauncherOption </span>is set to <span class='ec-lmtt-10'>Full </span>or <span class='ec-lmtt-10'>Short </span>then the OpenCore boot entry is protected. Resetting NVRAM will
normally erase any other boot options not specified via <span class='ec-lmtt-10'>BlessOverride</span>, for example Linux installations to custom locations
and not using the <span class='ec-lmtt-10'>OpenLinuxBoot </span>driver, or user-specified UEFI boot menu entries. To obtain reset NVRAM functionality
which does not remove other boot options, it is possible to use the <span class='ec-lmtt-10'>--preserve-boot </span>option (though see the warning
specified).
</p><!-- l. 6824 --><p class='noindent'>The following configuration options may be specified in the <span class='ec-lmtt-10'>Arguments </span>section for this driver:
</p>
     <ul class='itemize1'>
     <li class='itemize'>
     <!-- l. 6827 --><p class='noindent'><span class='ec-lmtt-10'>--preserve-boot </span>- Boolean flag, enabled if present.
     </p><!-- l. 6829 --><p class='noindent'>If enabled, BIOS boot entries are not cleared during NVRAM reset. This option should be used with caution,
     as some boot problems can be fixed by clearing these entries.
                                                                                                  
                                                                                                  
     </p></li>
     <li class='itemize'>
     <!-- l. 6832 --><p class='noindent'><span class='ec-lmtt-10'>--apple </span>- Boolean flag, enabled if present.
     </p><!-- l. 6834 --><p class='noindent'>On Apple firmware only, this performs a system NVRAM reset. This can result in additional, desirable operations
     such as NVRAM garbage collection. This is achieved by setting the <span class='ec-lmtt-10'>ResetNVRam </span>NVRAM variable. Where
     available, this has the same effect as pressing <span class='ec-lmtt-10'>CMD+OPT+P+R </span>during native boot, although note that if accessed
     from the menu entry only one boot chime will be heard.
     </p><!-- l. 6840 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Due to using system NVRAM reset, this option is not compatible with the <span class='ec-lmtt-10'>--preserve-boot </span>option
     and will override it, therefore all BIOS boot entries will be removed.
     </p><!-- l. 6843 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Due to using system NVRAM reset, the OpenCore boot option cannot be preserved and OpenCore will
     have to either be reselected in the native boot picker or re-blessed.
     </p><!-- l. 6847 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: On non-Apple hardware, this option will still set this variable but the variable will not be recognised by
     the firmware and no NVRAM reset will happen. </p></li></ul>
<!-- l. 6851 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='togglesipentry'><span class='titlemark'>11.7.2   </span> <a id='x1-7500011.7.2'></a>ToggleSipEntry</h5>
<!-- l. 6853 --><p class='noindent'>Provides a boot entry for enabling and disabling System Integrity Protection (SIP) in OpenCore picker.
</p><!-- l. 6855 --><p class='noindent'>While macOS is running, SIP involves multiple configured software protection systems, however all the information about
which of these protections to enable is stored in the single Apple NVRAM variable <span class='ec-lmtt-10'>csr-active-config</span>. As long as this
variable is set before macOS startup, SIP will be fully configured, so setting the variable using this boot option (or in any other
way, before macOS starts) has exactly the same end result as configuring SIP using the <span class='ec-lmtt-10'>csrutil </span>command in macOS
Recovery.
</p><!-- l. 6862 --><p class='noindent'><span class='ec-lmtt-10'>csr-active-config </span>will be toggled between <span class='ec-lmtt-10'>0 </span>for enabled, and a user-specified or default value for disabled. The default value
is <span class='ec-lmtt-10'>0x27F </span>(see below). Any other required value can be specified as a single number in the <span class='ec-lmtt-10'>Arguments </span>for this driver. This can
be specified as hexadecimal, beginning with <span class='ec-lmtt-10'>0x</span>, or as decimal.
</p><!-- l. 6867 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: It is recommended not to run macOS with SIP disabled. Use of this boot option may make it easier to quickly disable
SIP protection when genuinely needed - it should be re-enabled again afterwards.
</p><!-- l. 6871 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: The default value for disabling SIP with this boot entry is <span class='ec-lmtt-10'>0x27F</span>. For comparison, <span class='ec-lmtt-10'>csrutil disable </span>with no other
arguments on macOS Big Sur and Monterey sets <span class='ec-lmtt-10'>0x7F</span>, and on Catalina it sets <span class='ec-lmtt-10'>0x77</span>. The OpenCore default value of <span class='ec-lmtt-10'>0x27F </span>is a
variant of the Big Sur and Monterey value, chosen as follows: </p>
     <ul class='itemize1'>
     <li class='itemize'><span class='ec-lmtt-10'>CSR_ALLOW_UNAPPROVED_KEXTS </span>(<span class='ec-lmtt-10'>0x200</span>) is included in the default value, since it is generally useful, in the case
     where you need to have SIP disabled anyway, to be able to install unsigned kexts without manual approval in
     System Preferences.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>CSR_ALLOW_UNAUTHENTICATED_ROOT </span>(<span class='ec-lmtt-10'>0x800</span>) is not included in the default value, as it is very easy when using it
     to inadvertently break OS seal and prevent incremental OTA updates.
     </li>
     <li class='itemize'>If unsupported bits from a later OS are specified in <span class='ec-lmtt-10'>csr-active-config </span>(e.g. specifying <span class='ec-lmtt-10'>0x7F </span>on Catalina) then
     <span class='ec-lmtt-10'>csrutil status </span>will report that SIP has a non-standard value, however protection will be functionally the same.</li></ul>
                                                                                                  
                                                                                                  
<!-- l. 6887 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='audiodxe'><span class='titlemark'>11.8   </span> <a id='x1-7600011.8'></a>AudioDxe</h4>
<!-- l. 6889 --><p class='noindent'>High Definition Audio support driver in UEFI firmware for most Intel and some other analog audio controllers.
</p><!-- l. 6891 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: AudioDxe is a staging driver, refer to <a href='https://github.com/acidanthera/bugtracker/issues/740'>acidanthera/bugtracker#740</a> for known issues.
</p><!-- l. 6894 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='configuration2'><span class='titlemark'>11.8.1   </span> <a id='x1-7700011.8.1'></a>Configuration</h5>
<!-- l. 6896 --><p class='noindent'>Most UEFI audio configuration is handled via the <a href='#audio-properties'><span class='ec-lmtt-10'>UEFI Audio Properties</span></a> section, but if required the following additonal
configuration options (which are needed to produce sound on most Apple hardware, and possibly some others) may be
specified in <span class='ec-lmtt-10'>UEFI/Drivers/Arguments</span>:
</p>
     <ul class='itemize1'>
     <li class='itemize'>
     <!-- l. 6902 --><p class='noindent'><span class='ec-lmtt-10'>--gpio-setup </span>- Default value is <span class='ec-lmtt-10'>0 </span>(GPIO setup disabled) if argument is not provided, or <span class='ec-lmtt-10'>7 </span>(all GPIO setup
     stages stages enabled) if the argument is provided with no value.
     </p><!-- l. 6905 --><p class='noindent'>Available values, which may be combined by adding, are:
</p>
         <ul class='itemize2'>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000001 </span>(bit <span class='ec-lmtt-10'>0</span>) — <span class='ec-lmtt-10'>GPIO_SETUP_STAGE_DATA</span>, set GPIO pin data high on specified pins. Required e.g.
         on <span class='ec-lmtt-10'>MacBookPro10,2 </span>and <span class='ec-lmtt-10'>MacPro5,1</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000002 </span>(bit <span class='ec-lmtt-10'>1</span>) — <span class='ec-lmtt-10'>GPIO_SETUP_STAGE_DIRECTION</span>, set GPIO data direction to output on specified pins.
         Required e.g. on <span class='ec-lmtt-10'>MacPro5,1</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0x00000004 </span>(bit <span class='ec-lmtt-10'>2</span>) — <span class='ec-lmtt-10'>GPIO_SETUP_STAGE_ENABLE</span>, enable specified GPIO pins. Required e.g. on <span class='ec-lmtt-10'>MacPro5,1</span>.</li></ul>
     <!-- l. 6917 --><p class='noindent'>If audio appears to be ‘playing’ on the correct codec, e.g. based on the debug log, but no sound is heard on any channel,
     it is suggested to use <span class='ec-lmtt-10'>--gpio-setup </span>(with no value) in the AudioDxe driver arguments. If specified with no
     value, all stages will be enabled (equivalent of specifying <span class='ec-lmtt-10'>7</span>). If this produces sound, it is then possible to
     try fewer bits, e.g. <span class='ec-lmtt-10'>--gpio-setup=1</span>, <span class='ec-lmtt-10'>--gpio-setup=3</span>, to find out which stages are actually required.
     </p><!-- l. 6924 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Value <span class='ec-lmtt-10'>7 </span>(all flags enabled) of this option – as required for the <span class='ec-lmtt-10'>MacPro5,1 </span>– is compatible with most systems, but is
     known to cause problems with sound (previous sounds are not allowed to finish before new sounds start) on a small
     number of other systems, hence this option is not enabled by default.
     </p></li>
     <li class='itemize'>
     <!-- l. 6929 --><p class='noindent'><span class='ec-lmtt-10'>--gpio-pins </span>- Default: <span class='ec-lmtt-10'>0</span>, auto-detect.
     </p><!-- l. 6931 --><p class='noindent'>Specifies which GPIO pins should be operated on by <span class='ec-lmtt-10'>--gpio-setup</span>. This is a bit mask, with possible values from <span class='ec-lmtt-10'>0x0 </span>to
     <span class='ec-lmtt-10'>0xFF</span>. The usable maximum depends on the number if available pins on the audio out function group of the codec
     in use, e.g. it is <span class='ec-lmtt-10'>0x3 </span>(lowest two bits) if two GPIO pins are present, <span class='ec-lmtt-10'>0x7 </span>if three pins are present, etc.
     </p><!-- l. 6937 --><p class='noindent'>When <span class='ec-lmtt-10'>--gpio-setup </span>is enabled (i.e. non-zero), then <span class='ec-lmtt-10'>0 </span>is a special value for <span class='ec-lmtt-10'>--gpio-pins</span>, meaning that the pin mask will
     be auto-generated based on the reported number of GPIO pins on the specified codec (see <span class='ec-lmtt-10'>AudioCodec</span>), e.g. if the
                                                                                                  
                                                                                                  
     codec’s audio out function group reports 4 GPIO pins, a mask of <span class='ec-lmtt-10'>0xF </span>will be used. The value in use can be seen in the
     debug log in a line such as:
     </p><!-- l. 6943 --><p class='noindent'><span class='ec-lmtt-10'>HDA: GPIO setup on pins 0x0F - Success</span>
     </p><!-- l. 6945 --><p class='noindent'>Values for driver parameters can be specified in hexadecimal beginning with <span class='ec-lmtt-10'>0x </span>or in decimal, e.g. <span class='ec-lmtt-10'>--gpio-pins=0x12 </span>or
     <span class='ec-lmtt-10'>--gpio-pins=18</span>.
     </p></li>
     <li class='itemize'>
     <!-- l. 6948 --><p class='noindent'><span class='ec-lmtt-10'>--restore-nosnoop </span>- Boolean flag, enabled if present.
     </p><!-- l. 6950 --><p class='noindent'>AudioDxe clears the Intel HDA No Snoop Enable (NSNPEN) bit. On some systems, this change must be reversed on exit
     in order to avoid breaking sound in Windows. If so, this flag should be added to AudioDxe driver arguments. Not enabled
     by default, since restoring the flag can prevent sound from working in macOS on some other systems.
     </p></li></ul>
<!-- l. 6957 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='properties7'><span class='titlemark'>11.9   </span> <a id='x1-7800011.9'></a>Properties</h4>
<!-- l. 6959 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-78002x1'><span class='ec-lmtt-10'>APFS</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide APFS support as configured in the <a href='#apfs-properties'>APFS Properties</a> section below.
     </li>
<li class='enumerate' id='x1-78004x2'>
     <!-- l. 6968 --><p class='noindent'><span class='ec-lmtt-10'>Audio</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure audio backend support described in the <a href='#audio-properties'><span class='ec-lmtt-10'>Audio Properties</span></a> section below.
     </p><!-- l. 6974 --><p class='noindent'>Unless documented otherwise (e.g. <span class='ec-lmtt-10'>ResetTrafficClass</span>) settings in this section are for UEFI audio support only
     (e.g. OpenCore generated boot chime and audio assist) and are unrelated to any configuration needed for OS
     audio support (e.g. <span class='ec-lmtt-10'>AppleALC</span>).
     </p><!-- l. 6978 --><p class='noindent'>UEFI audio support provides a way for upstream protocols to interact with the selected audio hardware and
     resources. All audio resources should reside in <span class='ec-lmtt-10'>\EFI\OC\Resources\Audio </span>directory. Currently the supported
     audio file formats are MP3 and WAVE PCM. While it is driver-dependent which audio stream format is supported,
     most common audio cards support 16-bit signed stereo audio at 44100 or 48000 Hz.
     </p><!-- l. 6985 --><p class='noindent'>Audio file path is determined by audio type, audio localisation, and audio path. Each filename looks as follows:
     <span class='ec-lmtt-10'>[audio type]_[audio localisation]_[audio path].[audio ext]</span>.  For  unlocalised  files  filename  does  not
     include the language code and looks as follows: <span class='ec-lmtt-10'>[audio type]_[audio path].[audio ext]</span>. Audio extension
     can either be <span class='ec-lmtt-10'>mp3 </span>or <span class='ec-lmtt-10'>wav</span>.
</p>
         <ul class='itemize1'>
         <li class='itemize'>Audio type can be <span class='ec-lmtt-10'>OCEFIAudio </span>for OpenCore audio files or <span class='ec-lmtt-10'>AXEFIAudio </span>for macOS bootloader audio files.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'>Audio localisation is a two letter language code (e.g. <span class='ec-lmtt-10'>en</span>) with an exception for Chinese, Spanish, and
         Portuguese. Refer to <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/Protocol/AppleVoiceOver.h'><span class='ec-lmtt-10'>APPLE_VOICE_OVER_LANGUAGE_CODE </span>definition</a> for the list of all supported localisations.
         </li>
         <li class='itemize'>Audio path is the base filename corresponding to a file identifier. For macOS bootloader audio paths refer to
         <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Apple/Protocol/AppleVoiceOver.h'><span class='ec-lmtt-10'>APPLE_VOICE_OVER_AUDIO_FILE </span>definition</a>. For OpenCore audio paths refer to <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Acidanthera/Protocol/OcAudio.h'><span class='ec-lmtt-10'>OC_VOICE_OVER_AUDIO_FILE</span>
         definition</a>. The only exception is OpenCore boot chime file, which is <span class='ec-lmtt-10'>OCEFIAudio_VoiceOver_Boot.mp3</span>.</li></ul>
     <!-- l. 7006 --><p class='noindent'>Audio localisation is determined separately for macOS bootloader and OpenCore. For macOS bootloader it is set in
     <span class='ec-lmtt-10'>preferences.efires </span>archive in <span class='ec-lmtt-10'>systemLanguage.utf8 </span>file and is controlled by the operating system. For
     OpenCore the value of <span class='ec-lmtt-10'>prev-lang:kbd </span>variable is used. When native audio localisation of a particular file is
     missing, English language (<span class='ec-lmtt-10'>en</span>) localisation is used. Sample audio files can be found in <a href='https://github.com/acidanthera/OcBinaryData'>OcBinaryData
     repository</a>.
     </p></li>
<li class='enumerate' id='x1-78006x3'>
     <!-- l. 7015 --><p class='noindent'><span class='ec-lmtt-10'>ConnectDrivers</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform UEFI controller connection after driver loading.
     </p><!-- l. 7020 --><p class='noindent'>This option is useful for loading drivers following UEFI driver model as they may not start by themselves. Examples of
     such drivers are filesystem or audio drivers. While effective, this option may not be necessary for drivers performing
     automatic connection, and may slightly slowdown the boot.
     </p><!-- l. 7025 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Some types of firmware, particularly those made by Apple, only connect the boot drive to speed
     up the boot process. Enable this option to be able to see all the boot options when running multiple
     drives.
     </p></li>
<li class='enumerate' id='x1-78008x4'>
     <!-- l. 7030 --><p class='noindent'><span class='ec-lmtt-10'>Drivers</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load selected drivers from <span class='ec-lmtt-10'>OC/Drivers </span>directory.
     </p><!-- l. 7035 --><p class='noindent'>To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing each driver. Refer to the <a href='#drivers-properties'>Drivers Properties</a> section below.
     </p></li>
<li class='enumerate' id='x1-78010x5'><span class='ec-lmtt-10'>Input</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual settings designed for input (keyboard and mouse) in the <a href='#input-properties'>Input Properties</a> section
     below.
     </li>
<li class='enumerate' id='x1-78012x6'><span class='ec-lmtt-10'>Output</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual settings designed for output (text and graphics) in the <a href='#output-properties'>Output Properties</a> section
     below.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-78014x7'>
     <!-- l. 7053 --><p class='noindent'><span class='ec-lmtt-10'>ProtocolOverrides</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Force builtin versions of certain protocols described in the <a href='#protocoloverrides-properties'>ProtocolOverrides Properties</a> section
     below.
     </p><!-- l. 7059 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: all protocol instances are installed prior to driver loading.
     </p></li>
<li class='enumerate' id='x1-78016x8'><span class='ec-lmtt-10'>Quirks</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist dict</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: None<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apply individual firmware quirks described in the <a href='#quirks-properties3'>Quirks Properties</a> section below.
     </li>
<li class='enumerate' id='x1-78018x9'><span class='ec-lmtt-10'>ReservedMemory</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist array</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: To be filled with <span class='ec-lmtt-10'>plist dict </span>values, describing memory areas exclusive to specific firmware and hardware
     functioning, which should not be used by the operating system. Examples of such memory regions could be the second
     256 MB corrupted by the Intel HD 3000 or an area with faulty RAM. Refer to the <a href='#reservedmemory-properties'>ReservedMemory Properties</a> section
     below for details.
</li></ol>
<!-- l. 7080 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='apfs-properties'><span class='titlemark'>11.10   </span> <a id='x1-7900011.10'></a>APFS Properties</h4>
<!-- l. 7082 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-79002x1'>
     <!-- l. 7085 --><p class='noindent'><span class='ec-lmtt-10'>EnableJumpstart</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load embedded APFS drivers from APFS containers.
     </p><!-- l. 7090 --><p class='noindent'>An APFS EFI driver is bundled in all bootable APFS containers. This option performs the loading of signed
     APFS drivers (consistent with the <span class='ec-lmtt-10'>ScanPolicy</span>). Refer to the “EFI Jumpstart” section of the <a href='https://developer.apple.com/support/apple-file-system/Apple-File-System-Reference.pdf'>Apple File System
     Reference</a> for details.
     </p></li>
<li class='enumerate' id='x1-79004x2'>
     <!-- l. 7097 --><p class='noindent'><span class='ec-lmtt-10'>GlobalConnect</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Perform full device connection during APFS loading.
     </p><!-- l. 7102 --><p class='noindent'>Every handle is connected recursively instead of the partition handle connection typically used for APFS driver
     loading. This may result in additional time being taken but can sometimes be the only way to access APFS
     partitions on certain firmware, such as those on older HP laptops.
     </p></li>
<li class='enumerate' id='x1-79006x3'>
     <!-- l. 7108 --><p class='noindent'><span class='ec-lmtt-10'>HideVerbose</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Hide verbose output from APFS driver.
     </p><!-- l. 7113 --><p class='noindent'>APFS verbose output can be useful for debugging.
     </p></li>
<li class='enumerate' id='x1-79008x4'>
     <!-- l. 7116 --><p class='noindent'><span class='ec-lmtt-10'>JumpstartHotPlug</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Load APFS drivers for newly connected devices.
     </p><!-- l. 7121 --><p class='noindent'>Permits  APFS  USB  hot  plug  which  enables  loading  APFS  drivers,  both  at  OpenCore  startup  and  during
     OpenCore picker display. Disable if not required.
     </p></li>
<li class='enumerate' id='x1-79010x5'>
     <!-- l. 7125 --><p class='noindent'><span class='ec-lmtt-10'>MinDate</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Minimal allowed APFS driver date.
     </p><!-- l. 7130 --><p class='noindent'>The APFS driver date connects the APFS driver with the calendar release date. Apple ultimately drops support
     for older macOS releases and APFS drivers from such releases may contain vulnerabilities that can be used to
     compromise a computer if such drivers are used after support ends. This option permits restricting APFS drivers
     to current macOS versions.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0 </span>— require the default supported release date of APFS in OpenCore. The default release date will increase
         with time and thus this setting is recommended. Currently set to 2021/01/01.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-1 </span>— permit any release date to load (strongly discouraged).
         </li>
         <li class='itemize'>Other — use custom minimal APFS release date, e.g. <span class='ec-lmtt-10'>20200401 </span>for 2020/04/01. APFS release dates can be
         found in OpenCore boot log and <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Acidanthera/Library/OcApfsLib.h'><span class='ec-lmtt-10'>OcApfsLib</span></a>.</li></ul>
     </li>
<li class='enumerate' id='x1-79012x6'>
     <!-- l. 7148 --><p class='noindent'><span class='ec-lmtt-10'>MinVersion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Minimal allowed APFS driver version.
     </p><!-- l. 7153 --><p class='noindent'>The APFS driver version connects the APFS driver with the macOS release. Apple ultimately drops support for older
     macOS releases and APFS drivers from such releases may contain vulnerabilities that can be used to compromise a
     computer if such drivers are used after support ends. This option permits restricting APFS drivers to current macOS
     versions.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>0 </span>—  require  the  default  supported  version  of  APFS  in  OpenCore.  The  default  version  will  increase
         with  time  and  thus  this  setting  is  recommended.  Currently  set  to  allow  macOS  Big  Sur  and  newer
         (<span class='ec-lmtt-10'>1600000000000000</span>).
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-1 </span>— permit any version to load (strongly discouraged).
         </li>
         <li class='itemize'>Other — use custom minimal APFS version, e.g. <span class='ec-lmtt-10'>1412101001000000 </span>from macOS Catalina 10.15.4. APFS
         versions can be found in OpenCore boot log and <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Acidanthera/Library/OcApfsLib.h'><span class='ec-lmtt-10'>OcApfsLib</span></a>.</li></ul>
     </li></ol>
<!-- l. 7173 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='appleinput-properties'><span class='titlemark'>11.11   </span> <a id='x1-8000011.11'></a>AppleInput Properties</h4>
<!-- l. 7175 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-80002x1'>
     <!-- l. 7178 --><p class='noindent'><span class='ec-lmtt-10'>AppleEvent</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Determine whether the OpenCore builtin or the OEM Apple Event protocol is used.
     </p><!-- l. 7183 --><p class='noindent'>This option determines whether the OEM Apple Event protocol is used (where available), or whether OpenCore’s
     reversed engineered and updated re-implementation is used. In general OpenCore’s re-implementation should be
     preferred, since it contains updates such as noticeably improved fine mouse cursor movement and configurable
     key repeat delays.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Auto </span>— Use the OEM Apple Event implementation if available, connected and recent enough to be used,
         otherwise use the OpenCore re-implementation. On non-Apple hardware, this will use the OpenCore builtin
         implementation. On some Macs such as Classic Mac Pros, this will prefer the Apple implementation but on
         both older and newer Mac models than these, this option will typically use the OpenCore re-implementation
         instead. On older Macs, this is because the implementation available is too old to be used while on newer
         Macs,  it  is  because  of  optimisations  added  by  Apple  which  do  not  connect  the  Apple  Event  protocol
         except when needed – e.g. except when the Apple boot picker is explicitly started. Due to its somewhat
         unpredicatable results, this option is not typically recommended.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Builtin </span>—  Always  use  OpenCore’s  updated  re-implementation  of  the  Apple  Event  protocol.  Use  of
         this setting is recommended even on Apple hardware, due to improvements (better fine mouse control,
         configurable key delays) made in the OpenCore re-implementation of the protocol.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>OEM </span>— Assume Apple’s protocol will be available at driver connection. On all Apple hardware where a
         recent enough Apple OEM version of the protocol is available – whether or not connected automatically
         by Apple’s firmware – this option will reliably access the Apple implementation. On all other systems, this
         option will result in no keyboard or mouse support. For the reasons stated, <span class='ec-lmtt-10'>Builtin </span>is recommended in
         preference to this option in most cases.</li></ul>
     </li>
<li class='enumerate' id='x1-80004x2'>
     <!-- l. 7211 --><p class='noindent'><span class='ec-lmtt-10'>CustomDelays</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable custom key repeat delays when using the OpenCore re-implementation of the Apple Event
     protocol. Has no effect when using the OEM Apple implementation (see <span class='ec-lmtt-10'>AppleEvent </span>setting).
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>true </span>— The values of <span class='ec-lmtt-10'>KeyInitialDelay </span>and <span class='ec-lmtt-10'>KeySubsequentDelay </span>are used.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>false </span>— Apple default values of 500ms (<span class='ec-lmtt-10'>50</span>) and 50ms (<span class='ec-lmtt-10'>5</span>) are used.</li></ul>
     </li>
<li class='enumerate' id='x1-80006x3'>
     <!-- l. 7225 --><p class='noindent'><span class='ec-lmtt-10'>KeyInitialDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>50 </span>(500ms before first key repeat)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configures the initial delay before keyboard key repeats in the OpenCore re-implementation of the Apple
     Event protocol, in units of 10ms.
     </p><!-- l. 7231 --><p class='noindent'>The Apple OEM default value is <span class='ec-lmtt-10'>50 </span>(500ms).
     </p><!-- l. 7233 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: On systems not using <span class='ec-lmtt-10'>KeySupport</span>, this setting may be freely used to configure key repeat behaviour.
     </p><!-- l. 7236 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: On systems using <span class='ec-lmtt-10'>KeySupport</span>, but which do not show the ‘two long delays’ behavior (see Note 3) and/or which
     always show a solid ‘set default’ indicator (see <span class='ec-lmtt-10'>KeyForgetThreshold</span>) then this setting may also be freely used to
     configure key repeat initial delay behaviour, except that it should never be set to less than <span class='ec-lmtt-10'>KeyForgetThreshold </span>to avoid
     uncontrolled key repeats.
     </p><!-- l. 7242 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: On some systems using <span class='ec-lmtt-10'>KeySupport</span>, you may find that you see one additional slow key repeat before normal
     speed key repeat starts, when holding a key down. If so, you may wish to configure <span class='ec-lmtt-10'>KeyInitialDelay </span>and
     <span class='ec-lmtt-10'>KeySubsequentDelay </span>according to the instructions at Note 3 of <span class='ec-lmtt-10'>KeySubsequentDelay</span>.
     </p></li>
<li class='enumerate' id='x1-80008x4'>
     <!-- l. 7249 --><p class='noindent'><span class='ec-lmtt-10'>KeySubsequentDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>5 </span>(50ms between subsequent key repeats)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configures the gap between keyboard key repeats in the OpenCore re-implementation of the Apple Event
     protocol, in units of 10ms.
     </p><!-- l. 7255 --><p class='noindent'>The Apple OEM default value is <span class='ec-lmtt-10'>5 </span>(50ms). <span class='ec-lmtt-10'>0 </span>is an invalid value for this option (will issue a debug log warning and use <span class='ec-lmtt-10'>1</span>
     instead).
     </p><!-- l. 7258 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: On systems not using <span class='ec-lmtt-10'>KeySupport</span>, this setting may be freely used to configure key repeat behaviour.
     </p><!-- l. 7261 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: On systems using <span class='ec-lmtt-10'>KeySupport</span>, but which do not show the ‘two long delays’ behaviour (see Note 3) and/or which
     always show a solid ‘set default’ indicator (see <span class='ec-lmtt-10'>KeyForgetThreshold</span>) (which should apply to many/most systems using
     <span class='ec-lmtt-10'>AMI KeySupport </span>mode) then this setting may be freely used to configure key repeat subsequent delay
     behaviour, except that it should never be set to less than <span class='ec-lmtt-10'>KeyForgetThreshold </span>to avoid uncontrolled key
     repeats.
     </p><!-- l. 7268 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: On some systems using <span class='ec-lmtt-10'>KeySupport</span>, particularly <span class='ec-lmtt-10'>KeySupport </span>in non-<span class='ec-lmtt-10'>AMI </span>mode, you may find that after
     configuring <span class='ec-lmtt-10'>KeyForgetThreshold </span>you get one additional slow key repeat before normal speed key repeat starts, when
     holding a key down. On systems where this is the case, it is an unavoidable artefect of using <span class='ec-lmtt-10'>KeySupport </span>to emulate raw
     keyboard data, which is not made available by UEFI. While this ‘two long delays’ issue has minimal
     effect on overall usability, nevertheless you may wish to resolve it, and it is possible to do so as follows:
     </p>
         <ul class='itemize1'>
         <li class='itemize'>Set <span class='ec-lmtt-10'>CustomDelays </span>to <span class='ec-lmtt-10'>true</span>
         </li>
         <li class='itemize'>Set <span class='ec-lmtt-10'>KeyInitialDelay </span>to <span class='ec-lmtt-10'>0</span>
         </li>
         <li class='itemize'>Set <span class='ec-lmtt-10'>KeySubsequentDelay </span>to at least the value of your <span class='ec-lmtt-10'>KeyForgetThreshold </span>setting</li></ul>
     <!-- l. 7281 --><p class='noindent'>The above procedure works as follows: </p>
         <ul class='itemize1'>
         <li class='itemize'>Setting <span class='ec-lmtt-10'>KeyInitialDelay </span>to <span class='ec-lmtt-10'>0 </span>cancels the Apple Event initial repeat delay (when using the OpenCore
         builtin Apple Event implementation with <span class='ec-lmtt-10'>CustomDelays </span>enabled), therefore the only long delay you will
         see is the the non-configurable and non-avoidable initial long delay introduced by the BIOS key support on
         these machines.
         </li>
         <li class='itemize'>Key-smoothing parameter <span class='ec-lmtt-10'>KeyForgetThreshold </span>effectively acts as the shortest time for which a key can
         appear to be held, therefore a key repeat delay of less than this will guarantee at least one extra repeat for
         every key press, however quickly the key is physically tapped.
         </li>
         <li class='itemize'>In   the   unlikely   event   that   you   still   get   frequent,   or   occasional,   double   key   responses   after
         setting  <span class='ec-lmtt-10'>KeySubsequentDelay </span>equal  to  your  system’s  value  of  <span class='ec-lmtt-10'>KeyForgetThreshold</span>,  then  increase
         <span class='ec-lmtt-10'>KeySubsequentDelay </span>by one or two more until this effect goes away.</li></ul>
     </li>
<li class='enumerate' id='x1-80010x5'>
     <!-- l. 7298 --><p class='noindent'><span class='ec-lmtt-10'>GraphicsInputMirroring</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Apple’s own implementation of AppleEvent prevents keyboard input during graphics applications from
     appearing on the basic console input stream.
     </p><!-- l. 7305 --><p class='noindent'>With the default setting of <span class='ec-lmtt-10'>false</span>, OpenCore’s builtin implementation of AppleEvent replicates this behaviour.
     </p><!-- l. 7307 --><p class='noindent'>On non-Apple hardware this can stop keyboard input working in graphics-based applications such as Windows BitLocker
                                                                                                  
                                                                                                  
     which use non-Apple key input methods.
     </p><!-- l. 7310 --><p class='noindent'>The recommended setting on all hardware is <span class='ec-lmtt-10'>true</span>.
     </p><!-- l. 7312 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: AppleEvent’s default behaviour is intended to prevent unwanted queued keystrokes from appearing after exiting
     graphics-based UEFI applications; this issue is already handled separately within OpenCore.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>true </span>— Allow keyboard input to reach graphics mode apps which are not using Apple input protocols.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>false </span>— Prevent key input mirroring to non-Apple protocols when in graphics mode.</li></ul>
     </li>
<li class='enumerate' id='x1-80012x6'>
     <!-- l. 7322 --><p class='noindent'><span class='ec-lmtt-10'>PointerPollMin</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure minimal pointer polling period in ms.
     </p><!-- l. 7327 --><p class='noindent'>This is the minimal period the OpenCore builtin AppleEvent driver polls pointer devices (e.g. mice, trackpads) for
     motion events. The current implementation defaults to 10 ms. Setting <span class='ec-lmtt-10'>0 </span>leaves this default unchanged.
     </p><!-- l. 7332 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The OEM Apple implementation uses a polling rate of 2 ms.
     </p></li>
<li class='enumerate' id='x1-80014x7'>
     <!-- l. 7335 --><p class='noindent'><span class='ec-lmtt-10'>PointerPollMax</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure maximum pointer polling period in ms.
     </p><!-- l. 7340 --><p class='noindent'>This is the maximum period the OpenCore builtin AppleEvent driver polls pointer devices (e.g. mice, trackpads) for
     motion events. The period is increased up to this value as long as the devices do not respond in time. The current
     implementation defaults to 80 ms. Setting <span class='ec-lmtt-10'>0 </span>leaves this default unchanged.
     </p><!-- l. 7346 --><p class='noindent'>Certain trackpad drivers often found in Dell laptops can be very slow to respond when no physical movement happens.
     This can affect OpenCanopy and FileVault 2 user interface responsiveness and loading times. Increasing the polling
     periods can reduce the impact.
     </p><!-- l. 7351 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The OEM Apple implementation uses a polling rate of 2 ms.
     </p></li>
<li class='enumerate' id='x1-80016x8'>
     <!-- l. 7354 --><p class='noindent'><span class='ec-lmtt-10'>PointerPollMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer, 32 bit</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure indices of polled pointers.
     </p><!-- l. 7359 --><p class='noindent'>Selects pointer devices to poll for AppleEvent motion events. <span class='ec-lmtt-10'>-1 </span>implies all devices. A bit sum is used to determine
     particular devices. E.g. to enable devices 0, 2, 3 the value will be <span class='ec-lmtt-10'>1+4+8 </span>(corresponding powers of two). A total of 32
     configurable devices is supported.
     </p><!-- l. 7365 --><p class='noindent'>Certain pointer devices can be present in the firmware even when no corresponding physical devices are available. These
     devices usually are placeholders, aggregate devices, or proxies. Gathering information from these devices may result in
     inaccurate motion activity in the user interfaces and even cause performance issues. Disabling such pointer devices is
                                                                                                  
                                                                                                  
     recommended for laptop setups having issues of this kind.
     </p><!-- l. 7373 --><p class='noindent'>The amount of pointer devices available in the system can be found in the log. Refer to <span class='ec-lmtt-10'>Found N pointer devices</span>
     message for more details.
     </p><!-- l. 7377 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Has no effect when using the OEM Apple implementation (see <span class='ec-lmtt-10'>AppleEvent </span>setting).
     </p></li>
<li class='enumerate' id='x1-80018x9'>
     <!-- l. 7381 --><p class='noindent'><span class='ec-lmtt-10'>PointerSpeedDiv</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure pointer speed divisor in the OpenCore re-implementation of the Apple Event protocol. Has no
     effect when using the OEM Apple implementation (see <span class='ec-lmtt-10'>AppleEvent </span>setting).
     </p><!-- l. 7388 --><p class='noindent'>Configures the divisor for pointer movements. The Apple OEM default value is <span class='ec-lmtt-10'>1</span>. <span class='ec-lmtt-10'>0 </span>is an invalid value for this
     option.
     </p><!-- l. 7391 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The recommended value for this option is <span class='ec-lmtt-10'>1</span>. This value may optionally be modified in combination with
     <span class='ec-lmtt-10'>PointerSpeedMul</span>, according to user preference, to achieve customised mouse movement scaling.
     </p></li>
<li class='enumerate' id='x1-80020x10'>
     <!-- l. 7396 --><p class='noindent'><span class='ec-lmtt-10'>PointerSpeedMul</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure pointer speed multiplier in the OpenCore re-implementation of the Apple Event protocol. Has
     no effect when using the OEM Apple implementation (see <span class='ec-lmtt-10'>AppleEvent </span>setting).
     </p><!-- l. 7403 --><p class='noindent'>Configures the multiplier for pointer movements. The Apple OEM default value is <span class='ec-lmtt-10'>1</span>.
     </p><!-- l. 7405 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The recommended value for this option is <span class='ec-lmtt-10'>1</span>. This value may optionally be modified in combination with
     <span class='ec-lmtt-10'>PointerSpeedDiv</span>, according to user preference, to achieve customised mouse movement scaling.
</p>
     </li></ol>
<!-- l. 7411 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='audio-properties'><span class='titlemark'>11.12   </span> <a id='x1-8100011.12'></a>Audio Properties</h4>
<!-- l. 7413 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-81002x1'>
     <!-- l. 7416 --><p class='noindent'><span class='ec-lmtt-10'>AudioCodec</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Codec address on the specified audio controller for audio support.
     </p><!-- l. 7421 --><p class='noindent'>This typically contains the first audio codec address on the builtin analog audio controller (<span class='ec-lmtt-10'>HDEF</span>). Audio codec
     addresses, e.g. <span class='ec-lmtt-10'>2</span>, can be found in the debug log (marked in bold-italic):
     </p><!-- l. 7424 --><p class='noindent'><span class='ec-lmtt-10'>OCAU: 1/3 PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x1)/VenMsg(&lt;redacted&gt;,</span><span class='ec-lmtko-10'>00000000</span><span class='ec-lmtt-10'>) (4 outputs)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 2/3 PciRoot(0x0)/Pci(0x3,0x0)/VenMsg(&lt;redacted&gt;,</span><span class='ec-lmtko-10'>00000000</span><span class='ec-lmtt-10'>) (1 outputs)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 3/3 PciRoot(0x0)/Pci(0x1B,0x0)/VenMsg(&lt;redacted&gt;,</span><span class='ec-lmtko-10'>02000000</span><span class='ec-lmtt-10'>) (7 outputs)</span>
                                                                                                  
                                                                                                  
     </p><!-- l. 7428 --><p class='noindent'>As an alternative, this value can be obtained from <span class='ec-lmtt-10'>IOHDACodecDevice </span>class in I/O Registry containing it in
     <span class='ec-lmtt-10'>IOHDACodecAddress </span>field.
     </p></li>
<li class='enumerate' id='x1-81004x2'>
     <!-- l. 7432 --><p class='noindent'><span class='ec-lmtt-10'>AudioDevice</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Device path of the specified audio controller for audio support.
     </p><!-- l. 7437 --><p class='noindent'>This typically contains builtin analog audio controller (<span class='ec-lmtt-10'>HDEF</span>) device path, e.g. <span class='ec-lmtt-10'>PciRoot(0x0)/Pci(0x1b,0x0)</span>.
     The list of recognised audio controllers can be found in the debug log (marked in bold-italic):
     </p><!-- l. 7441 --><p class='noindent'><span class='ec-lmtt-10'>OCAU: 1/3 </span><span class='ec-lmtko-10'>PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x1)</span><span class='ec-lmtt-10'>/VenMsg(&lt;redacted&gt;,00000000) (4 outputs)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 2/3 </span><span class='ec-lmtko-10'>PciRoot(0x0)/Pci(0x3,0x0)</span><span class='ec-lmtt-10'>/VenMsg(&lt;redacted&gt;,00000000) (1 outputs)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 3/3 </span><span class='ec-lmtko-10'>PciRoot(0x0)/Pci(0x1B,0x0)</span><span class='ec-lmtt-10'>/VenMsg(&lt;redacted&gt;,02000000) (7 outputs)</span>
     </p><!-- l. 7445 --><p class='noindent'>If using <span class='ec-lmtt-10'>AudioDxe</span>, the available controller device paths are also output on lines formatted like this:
     </p><!-- l. 7447 --><p class='noindent'><span class='ec-lmtt-10'>HDA: Connecting controller - </span><span class='ec-lmtko-10'>PciRoot(0x0)/Pci(0x1B,0x0)</span>
     </p><!-- l. 7449 --><p class='noindent'>Finally, <span class='ec-lmtt-10'>gfxutil -f HDEF </span>command can be used in macOS to obtain the device path.
     </p><!-- l. 7451 --><p class='noindent'>Specifying an empty device path results in the first available codec and audio controller being used. The value
     of <span class='ec-lmtt-10'>AudioCodec </span>is ignored in this case. This can be a convenient initial option to try to get UEFI audio working.
     Manual settings as above will be required when this default value does not work.
     </p></li>
<li class='enumerate' id='x1-81006x3'>
     <!-- l. 7456 --><p class='noindent'><span class='ec-lmtt-10'>AudioOutMask</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Bit field indicating which output channels to use for UEFI sound.
     </p><!-- l. 7461 --><p class='noindent'>Audio mask is 1 « audio output (equivalently 2 <span class='ec-lmtt-10'>^ </span>audio output). E.g. for audio output <span class='ec-lmtt-10'>0 </span>the bitmask is <span class='ec-lmtt-10'>1</span>, for
     output <span class='ec-lmtt-10'>3 </span>it is <span class='ec-lmtt-10'>8</span>, and for outputs <span class='ec-lmtt-10'>0 </span>and <span class='ec-lmtt-10'>3 </span>it is <span class='ec-lmtt-10'>9</span>.
     </p><!-- l. 7464 --><p class='noindent'>The number of available output nodes (<span class='ec-lmtt-10'>N</span>) for each HDA codec is shown in the debug log (marked in bold-italic),
     audio outputs <span class='ec-lmtt-10'>0 </span>to <span class='ec-lmtt-10'>N - 1 </span>may be selected:
     </p><!-- l. 7467 --><p class='noindent'><span class='ec-lmtt-10'>OCAU: 1/3 PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x1)/VenMsg(&lt;redacted&gt;,00000000) (</span><span class='ec-lmtko-10'>4 outputs</span><span class='ec-lmtt-10'>)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 2/3 PciRoot(0x0)/Pci(0x3,0x0)/VenMsg(&lt;redacted&gt;,00000000) (</span><span class='ec-lmtko-10'>1 outputs</span><span class='ec-lmtt-10'>)</span><br class='newline' /><span class='ec-lmtt-10'>OCAU: 3/3 PciRoot(0x0)/Pci(0x1B,0x0)/VenMsg(&lt;redacted&gt;,02000000) (</span><span class='ec-lmtko-10'>7 outputs</span><span class='ec-lmtt-10'>)</span>
     </p><!-- l. 7471 --><p class='noindent'>When <span class='ec-lmtt-10'>AudioDxe </span>is used then additional information about each output channel is logged during driver binding,
     including the bitmask for each output. The bitmask values for the desired outputs should be added together to
     obtain the <span class='ec-lmtt-10'>AudioOutMask </span>value:
     </p><!-- l. 7475 --><p class='noindent'><span class='ec-lmtt-10'>HDA: | Port widget @ 0x9 is an output (pin defaults 0x2B4020) (</span><span class='ec-lmtko-10'>bitmask 1</span><span class='ec-lmtt-10'>)</span><br class='newline' /><span class='ec-lmtt-10'>HDA: | Port widget @ 0xA is an output (pin defaults 0x90100112) (</span><span class='ec-lmtko-10'>bitmask 2</span><span class='ec-lmtt-10'>)</span><br class='newline' /><span class='ec-lmtt-10'>HDA: | Port widget @ 0xB is an output (pin defaults 0x90100110) (</span><span class='ec-lmtko-10'>bitmask 4</span><span class='ec-lmtt-10'>)</span><br class='newline' /><span class='ec-lmtt-10'>HDA: | Port widget @ 0x10 is an output (pin defaults 0x4BE030) (</span><span class='ec-lmtko-10'>bitmask 8</span><span class='ec-lmtt-10'>)</span>
     </p><!-- l. 7480 --><p class='noindent'>Further information on the available output channels may be found from a Linux codec dump using the command:
     </p><!-- l. 7482 --><p class='noindent'><span class='ec-lmtt-10'>cat /proc/asound/card{n}/codec#{m}</span>
     </p><!-- l. 7484 --><p class='noindent'>Using <span class='ec-lmtt-10'>AudioOutMask</span>, it is possible to play sound to more than one channel (e.g. main speaker plus bass speaker;
     headphones plus speakers) as long as all the chosen outputs support the sound file format in use; if any do not
     then no sound will play and a warning will be logged.
     </p><!-- l. 7488 --><p class='noindent'>When all available output channels on the codec support the available sound file format then a value of <span class='ec-lmtt-10'>-1 </span>will
     play sound to all channels simultaneously. If this does not work it will usually be quickest to try each available
                                                                                                  
                                                                                                  
     output channel one by one, by setting <span class='ec-lmtt-10'>AudioOutMask </span>to <span class='ec-lmtt-10'>1</span>, <span class='ec-lmtt-10'>2</span>, <span class='ec-lmtt-10'>4</span>, etc., up to 2 <span class='ec-lmtt-10'>^ N - 1</span>, in order to work out which
     channel(s) produce sound.
     </p></li>
<li class='enumerate' id='x1-81008x4'>
     <!-- l. 7494 --><p class='noindent'><span class='ec-lmtt-10'>AudioSupport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Activate audio support by connecting to a backend driver.
     </p><!-- l. 7499 --><p class='noindent'>Enabling this setting routes audio playback from builtin protocols to specified (<span class='ec-lmtt-10'>AudioOutMask</span>) dedicated audio
     ports of the specified codec (<span class='ec-lmtt-10'>AudioCodec</span>), located on the specified audio controller (<span class='ec-lmtt-10'>AudioDevice</span>).
     </p></li>
<li class='enumerate' id='x1-81010x5'>
     <!-- l. 7504 --><p class='noindent'><span class='ec-lmtt-10'>DisconnectHda</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disconnect HDA controller before loading drivers.
     </p><!-- l. 7509 --><p class='noindent'>May be required on some systems (e.g. Apple hardware, VMware Fusion guest) to allow a UEFI sound driver
     (such as <span class='ec-lmtt-10'>AudioDxe</span>) to take control of the audio hardware.
     </p><!-- l. 7512 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: In addition to this option, most Apple hardware also requires the <span class='ec-lmtt-10'>--gpio-setup </span>driver argument which is
     dealt with in the <a href='#audiodxe'>AudioDxe</a> section.
     </p></li>
<li class='enumerate' id='x1-81012x6'>
     <!-- l. 7517 --><p class='noindent'><span class='ec-lmtt-10'>MaximumGain</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-15</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Maximum gain to use for UEFI audio, specified in decibels (dB) with respect to amplifier reference
     level of 0 dB (see note 1).
     </p><!-- l. 7523 --><p class='noindent'>All UEFI audio will use this gain setting when the system amplifier gain read from the <span class='ec-lmtt-10'>SystemAudioVolumeDB</span>
     NVRAM variable is higher than this. This is to avoid over-loud UEFI audio when the system volume is set very
     high, or the <span class='ec-lmtt-10'>SystemAudioVolumeDB </span>NVRAM value has been misconfigured.
     </p><!-- l. 7527 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Decibels (dB) specify gain (postive values; increase in volume) or attenuation (negative values; decrease
     in volume) compared to some reference level. When you hear the sound level of a jet plane expressed as 120
     decibels, say, the reference level is the sound level just audible to an average human. However generally in acoustic
     science and computer audio any reference level can be specified. Intel HDA and macOS natively use decibels
     to specify volume level. On most Intel HDA hardware the reference level of 0 dB is the <span class='ec-lmri-10'>loudest </span>volume of the
     hardware, and all lower volumes are therefore negative numbers. The quietest volume on typical sound hardware
     is around -55 dB to -60 dB.
     </p><!-- l. 7535 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Matching how macOS handles decibel values, this value is converted to a signed byte; therefore values
     outside <span class='lmsy-10'>−</span><span class='rm-lmr-10'>128 </span>dB to <span class='rm-lmr-10'>+127 </span>dB (which are well beyond physically plausible volume levels) are not allowed.
     </p><!-- l. 7538 --><p class='noindent'><span class='ec-lmri-10'>Note 3</span>: Digital audio output – which does not have a volume slider in-OS – ignores this and all other gain
     settings, only mute settings are relevant.
     </p></li>
<li class='enumerate' id='x1-81014x7'>
     <!-- l. 7542 --><p class='noindent'><span class='ec-lmtt-10'>MinimumAssistGain</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-30</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Minimum gain in decibels (dB) to use for picker audio assist.
     </p><!-- l. 7547 --><p class='noindent'>The screen reader will use this amplifier gain if the system amplifier gain read from the <span class='ec-lmtt-10'>SystemAudioVolumeDB</span>
     NVRAM variable is lower than this.
     </p><!-- l. 7550 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: In addition to this setting, because audio assist must be audible to serve its function, audio assist is not
     muted even if the OS sound is muted or the <span class='ec-lmtt-10'>StartupMute </span>NVRAM variable is set.
     </p><!-- l. 7553 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: See <span class='ec-lmtt-10'>MaximumGain </span>for an explanation of decibel volume levels.
     </p></li>
<li class='enumerate' id='x1-81016x8'>
     <!-- l. 7556 --><p class='noindent'><span class='ec-lmtt-10'>MinimumAudibleGain</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-128</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Minimum gain in decibels (dB) at which to attempt to play any sound.
     </p><!-- l. 7561 --><p class='noindent'>The boot chime will not play if the system amplifier gain level in the <span class='ec-lmtt-10'>SystemAudioVolumeDB </span>NVRAM variable
     is lower than this.
     </p><!-- l. 7564 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This setting is designed to save unecessary pauses due to audio setup at inaudible volume levels, when
     no sound will be heard anyway. Whether there are inaudible volume levels depends on the hardware. On some
     hardware (including Apple) the audio values are well enough matched to the hardware that the lowest volume
     levels available are very quiet but audible, whereas on some other hardware combinations, the lowest part of the
     volume range may not be audible at all.
     </p><!-- l. 7570 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: See <span class='ec-lmtt-10'>MaximumGain </span>for an explanation of decibel volume levels.
     </p></li>
<li class='enumerate' id='x1-81018x9'>
     <!-- l. 7573 --><p class='noindent'><span class='ec-lmtt-10'>PlayChime</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Play chime sound at startup.
     </p><!-- l. 7578 --><p class='noindent'>Enabling this setting plays the boot chime using the builtin audio support. The volume level is determined by
     the <span class='ec-lmtt-10'>SystemAudioVolumeDB </span>NVRAM variable. Supported values are:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Auto </span>— Enables chime when <span class='ec-lmtt-10'>StartupMute </span>NVRAM variable is not present or set to <span class='ec-lmtt-10'>00</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Enabled </span>— Enables chime unconditionally.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Disabled </span>— Disables chime unconditionally.</li></ul>
     <!-- l. 7589 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: <span class='ec-lmtt-10'>Enabled </span>can be used separately from the <span class='ec-lmtt-10'>StartupMute </span>NVRAM variable to avoid conflicts when the firmware is
     able to play the boot chime.
     </p><!-- l. 7592 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: Regardless of this setting, the boot chime will not play if system audio is muted, i.e. if the <span class='ec-lmtt-10'>SystemAudioVolume</span>
     NVRAM variable has bit <span class='ec-lmtt-10'>0x80 </span>set.
     </p></li>
<li class='enumerate' id='x1-81020x10'>
                                                                                                  
                                                                                                  
     <!-- l. 7596 --><p class='noindent'><span class='ec-lmtt-10'>ResetTrafficClass</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set HDA Traffic Class Select Register to <span class='ec-lmtt-10'>TC0</span>.
     </p><!-- l. 7601 --><p class='noindent'>AppleHDA kext will function correctly only if <span class='ec-lmtt-10'>TCSEL </span>register is configured to use <span class='ec-lmtt-10'>TC0 </span>traffic class. Refer to Intel I/O
     Controller Hub 9 (ICH9) Family Datasheet (or any other ICH datasheet) for more details about this
     register.
     </p><!-- l. 7605 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option is independent from <span class='ec-lmtt-10'>AudioSupport</span>. If AppleALC is used it is preferred to use AppleALC <span class='ec-lmtt-10'>alctsel</span>
     property instead.
     </p></li>
<li class='enumerate' id='x1-81022x11'>
     <!-- l. 7609 --><p class='noindent'><span class='ec-lmtt-10'>SetupDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Audio codec reconfiguration delay in microseconds.
     </p><!-- l. 7614 --><p class='noindent'>Some codecs require a vendor-specific delay after the reconfiguration (e.g. volume setting). This option makes it
     configurable. A typical delay can be up to 0.5 seconds.
</p>
     </li></ol>
<!-- l. 7620 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='drivers-properties'><span class='titlemark'>11.13   </span> <a id='x1-8200011.13'></a>Drivers Properties</h4>
<!-- l. 7622 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-82002x1'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-82004x2'><span class='ec-lmtt-10'>Path</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Path of file to be loaded as a UEFI driver from <span class='ec-lmtt-10'>OC/Drivers </span>directory.
     </li>
<li class='enumerate' id='x1-82006x3'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: If <span class='ec-lmtt-10'>false </span>this driver entry will be ignored.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-82008x4'><span class='ec-lmtt-10'>Arguments</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some OpenCore plugins accept optional additional arguments which may be specified as a string
     here.
</li></ol>
<!-- l. 7654 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='input-properties'><span class='titlemark'>11.14   </span> <a id='x1-8300011.14'></a>Input Properties</h4>
<!-- l. 7656 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-83002x1'>
     <!-- l. 7659 --><p class='noindent'><span class='ec-lmtt-10'>KeyFiltering</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable keyboard input sanity checking.
     </p><!-- l. 7664 --><p class='noindent'>Apparently some boards such as the GA Z77P-D3 may return uninitialised data in <span class='ec-lmtt-10'>EFI_INPUT_KEY </span>with all input
     protocols. This option discards keys that are neither ASCII, nor are defined in the UEFI specification (see tables
     107 and 108 in version 2.8).
     </p></li>
<li class='enumerate' id='x1-83004x2'>
     <!-- l. 7670 --><p class='noindent'><span class='ec-lmtt-10'>KeyForgetThreshold</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Treat duplicate key presses as held keys if they arrive during this timeout, in 10 ms units. Only
     applies to systems using <span class='ec-lmtt-10'>KeySupport</span>.
     </p><!-- l. 7676 --><p class='noindent'><span class='ec-lmtt-10'>AppleKeyMapAggregator </span>protocol is supposed to contain a fixed length buffer of currently pressed keys. However,
     the  majority  of  the  drivers  which  require  <span class='ec-lmtt-10'>KeySupport </span>report  key  presses  as  interrupts,  with  automatically
     generated key repeat behaviour with some defined initial and subsequent delay. As a result, to emulate the raw
     key behaviour required by several Apple boot systems, we use a timeout to merge multiple repeated keys which
     are submitted within a small timeout window.
     </p><!-- l. 7684 --><p class='noindent'>This option allows setting this timeout based on the platform. The recommended value for the majority of
     platforms is from <span class='ec-lmtt-10'>5 </span>(<span class='ec-lmtt-10'>50 </span>milliseconds) to <span class='ec-lmtt-10'>7 </span>(<span class='ec-lmtt-10'>70 </span>milliseconds), although values up to <span class='ec-lmtt-10'>9 </span>(<span class='ec-lmtt-10'>90 </span>milliseconds) have been
     observed to be required on some PS/2 systems. For reference, holding a key on VMware will repeat roughly
     every <span class='ec-lmtt-10'>20 </span>milliseconds and the equivalent value for APTIO V is <span class='ec-lmtt-10'>30-40 </span>milliseconds. <span class='ec-lmtt-10'>KeyForgetThreshold </span>should
     be configured to be longer than this. Thus, it is possible to configure a lower <span class='ec-lmtt-10'>KeyForgetThreshold </span>value on
     platforms with a faster native driver key repeat rate, for more responsive input, and it is required to set a higher
     value on slower platforms.
     </p><!-- l. 7695 --><p class='noindent'>Pressing keys one after the other results in delays of at least <span class='ec-lmtt-10'>60 </span>and <span class='ec-lmtt-10'>100 </span>milliseconds for the same platforms.
     Ideally, <span class='ec-lmtt-10'>KeyForgetThreshold </span>should remain lower than this value, to avoid merging real key presses.
     </p><!-- l. 7699 --><p class='noindent'>Tuning the value of <span class='ec-lmtt-10'>KeyForgetThreshold </span>is necessary for accurate and responsive keyboard input on systems
     on which <span class='ec-lmtt-10'>KeySupport </span>is enabled, and it is recommended to follow the instructions below to tune it correctly for
                                                                                                  
                                                                                                  
     your system.
     </p><!-- l. 7704 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: To tune <span class='ec-lmtt-10'>KeyForgetThreshold</span>, you may use the ‘set default’ indicator within either OpenCanopy or the
     builtin picker. If <span class='ec-lmtt-10'>KeyForgetThreshold </span>is too low then the ‘set default’ indicator will continue to flicker while
     <span class='ec-lmtt-10'>CTRL </span>or <span class='ec-lmtt-10'>=/+ </span>is held down. You should configure the lowest value which avoids this flicker. On some systems
     (e.g. Aptio IV and potentially other systems using <span class='ec-lmtt-10'>AMI KeySupport </span>mode) you will be able to find a minimum
     <span class='ec-lmtt-10'>KeyForgetThreshold </span>value at which the ‘set default’ indicator goes on and stays on with no flicker at all - if so,
     use this value. On most other systems using <span class='ec-lmtt-10'>KeySupport</span>, you will find that the ‘set default’ indicator will flicker
     once, when first pressing and holding the <span class='ec-lmtt-10'>CTRL </span>or <span class='ec-lmtt-10'>=/+ </span>key, and then after a further very brief interval will go on
     and stay on. On such systems, you should chose the lowest value of <span class='ec-lmtt-10'>KeyForgetThreshold </span>at which you see only
     one initial flicker and then no subsequent flickering. (Where this happens, it is an unavoidable artefect on those
     systems of using <span class='ec-lmtt-10'>KeySupport </span>to emulate raw keyboard data, which is not made available by UEFI.)
     </p><!-- l. 7721 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: <span class='ec-lmtt-10'>KeyForgetThreshold </span>should never need to be more than about <span class='ec-lmtt-10'>9 </span>or <span class='ec-lmtt-10'>10 </span>at most. If it is set to a
     value much higher than this, it will result in noticeably unresponsive keyboard input. Therefore, for overall
     key responsiveness, it is strongly recommended to configure a relatively lower value, at which the ‘set default’
     indicator flickers once and then does not flicker, rather than using a much higher value (i.e. significantly greater
     than <span class='ec-lmtt-10'>10</span>), which you may be able to find but should not use, where the ‘set default’ indicator does not flicker at
     all.
     </p></li>
<li class='enumerate' id='x1-83006x3'>
     <!-- l. 7729 --><p class='noindent'><span class='ec-lmtt-10'>KeySupport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable internal keyboard input translation to <span class='ec-lmtt-10'>AppleKeyMapAggregator </span>protocol.
     </p><!-- l. 7735 --><p class='noindent'>This option activates the internal keyboard interceptor driver, based on <span class='ec-lmtt-10'>AppleGenericInput</span>, also known as
     <span class='ec-lmtt-10'>AptioInputFix</span>, to fill the <span class='ec-lmtt-10'>AppleKeyMapAggregator </span>database for input functioning. In cases where a separate
     driver such as <span class='ec-lmtt-10'>OpenUsbKbDxe </span>is used, this option should never be enabled. Additionally, this option is not required
     and should not be enabled with Apple firmware.
     </p></li>
<li class='enumerate' id='x1-83008x4'>
     <!-- l. 7743 --><p class='noindent'><span class='ec-lmtt-10'>KeySupportMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Auto</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set internal keyboard input translation to <span class='ec-lmtt-10'>AppleKeyMapAggregator </span>protocol mode.
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Auto </span>— Performs automatic choice as available with the following preference: <span class='ec-lmtt-10'>AMI</span>, <span class='ec-lmtt-10'>V2</span>, <span class='ec-lmtt-10'>V1</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>V1 </span>— Uses UEFI standard legacy input protocol <span class='ec-lmtt-10'>EFI_SIMPLE_TEXT_INPUT_PROTOCOL</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>V2 </span>— Uses UEFI standard modern input protocol <span class='ec-lmtt-10'>EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>AMI </span>— Uses APTIO input protocol <span class='ec-lmtt-10'>AMI_EFIKEYCODE_PROTOCOL</span>.</li></ul>
     <!-- l. 7757 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Currently <span class='ec-lmtt-10'>V1</span>, <span class='ec-lmtt-10'>V2</span>, and <span class='ec-lmtt-10'>AMI </span>unlike <span class='ec-lmtt-10'>Auto </span>only do filtering of the particular specified protocol. This may change in the
     future versions.
     </p></li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-83010x5'>
     <!-- l. 7761 --><p class='noindent'><span class='ec-lmtt-10'>KeySwap</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Swap <span class='ec-lmtt-10'>Command </span>and <span class='ec-lmtt-10'>Option </span>keys during submission.
     </p><!-- l. 7766 --><p class='noindent'>This option may be useful for keyboard layouts with <span class='ec-lmtt-10'>Option </span>key situated to the right of <span class='ec-lmtt-10'>Command </span>key.
     </p></li>
<li class='enumerate' id='x1-83012x6'>
     <!-- l. 7770 --><p class='noindent'><span class='ec-lmtt-10'>PointerSupport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable internal pointer driver.
     </p><!-- l. 7775 --><p class='noindent'>This option implements standard UEFI pointer protocol (<span class='ec-lmtt-10'>EFI_SIMPLE_POINTER_PROTOCOL</span>) through certain
     OEM protocols. The option may be useful on Z87 ASUS boards, where <span class='ec-lmtt-10'>EFI_SIMPLE_POINTER_PROTOCOL </span>is
     defective.
     </p></li>
<li class='enumerate' id='x1-83014x7'>
     <!-- l. 7780 --><p class='noindent'><span class='ec-lmtt-10'>PointerSupportMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set OEM protocol used for internal pointer driver.
     </p><!-- l. 7785 --><p class='noindent'>Currently the only supported variant is <span class='ec-lmtt-10'>ASUS</span>, using specialised protocol available on certain Z87 and Z97 ASUS boards.
     More details can be found in <a href='https://github.com/LongSoft/UEFITool/pull/116'><span class='ec-lmtt-10'>LongSoft/UefiTool#116</span></a>. The value of this property cannot be empty if <span class='ec-lmtt-10'>PointerSupport </span>is
     enabled.
     </p></li>
<li class='enumerate' id='x1-83016x8'>
     <!-- l. 7791 --><p class='noindent'><span class='ec-lmtt-10'>TimerResolution</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Set architecture timer resolution.
     </p><!-- l. 7796 --><p class='noindent'>This option allows updating the firmware architecture timer period with the specified value in <span class='ec-lmtt-10'>100 </span>nanosecond
     units. Setting a lower value typically improves performance and responsiveness of the interface and input
     handling.
     </p><!-- l. 7800 --><p class='noindent'>The recommended value is <span class='ec-lmtt-10'>50000 </span>(<span class='ec-lmtt-10'>5 </span>milliseconds) or slightly higher. Select ASUS Z87 boards use <span class='ec-lmtt-10'>60000 </span>for the
     interface. Apple boards use <span class='ec-lmtt-10'>100000</span>. In case of issues, this option can be left as <span class='ec-lmtt-10'>0 </span>to not change the timer
     resolution.
</p>
     </li></ol>
<!-- l. 7806 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='output-properties'><span class='titlemark'>11.15   </span> <a id='x1-8400011.15'></a>Output Properties</h4>
<!-- l. 7808 --><p class='noindent'>
                                                                                                  
                                                                                                  
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-84002x1'>
     <!-- l. 7811 --><p class='noindent'><span class='ec-lmtt-10'>TextRenderer</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>BuiltinGraphics</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Chooses renderer for text going through standard console output.
     </p><!-- l. 7817 --><p class='noindent'>Currently two renderers are supported: <span class='ec-lmtt-10'>Builtin </span>and <span class='ec-lmtt-10'>System</span>. <span class='ec-lmtt-10'>System </span>renderer uses firmware services for text
     rendering. <span class='ec-lmtt-10'>Builtin </span>bypassing firmware services and performs text rendering on its own. Different renderers
     support a different set of options. It is recommended to use <span class='ec-lmtt-10'>Builtin </span>renderer, as it supports HiDPI mode and
     uses full screen resolution.
     </p><!-- l. 7824 --><p class='noindent'>UEFI firmware typically supports <span class='ec-lmtt-10'>ConsoleControl </span>with two rendering modes: <span class='ec-lmtt-10'>Graphics </span>and <span class='ec-lmtt-10'>Text</span>. Some types
     of firmware do not support <span class='ec-lmtt-10'>ConsoleControl </span>and rendering modes. OpenCore and macOS expect text to only be
     shown in <span class='ec-lmtt-10'>Graphics </span>mode and graphics to be drawn in any mode. Since this is not required by UEFI specification,
     exact behaviour varies.
     </p><!-- l. 7831 --><p class='noindent'>Valid values are combinations of text renderer and rendering mode:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>BuiltinGraphics </span>— Switch to <span class='ec-lmtt-10'>Graphics </span>mode and use <span class='ec-lmtt-10'>Builtin </span>renderer with custom <span class='ec-lmtt-10'>ConsoleControl</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BuiltinText </span>— Switch to <span class='ec-lmtt-10'>Text </span>mode and use <span class='ec-lmtt-10'>Builtin </span>renderer with custom <span class='ec-lmtt-10'>ConsoleControl</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>SystemGraphics </span>— Switch to <span class='ec-lmtt-10'>Graphics </span>mode and use <span class='ec-lmtt-10'>System </span>renderer with custom <span class='ec-lmtt-10'>ConsoleControl</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>SystemText </span>— Switch to <span class='ec-lmtt-10'>Text </span>mode and use <span class='ec-lmtt-10'>System </span>renderer with custom <span class='ec-lmtt-10'>ConsoleControl</span>.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>SystemGeneric </span>— Use <span class='ec-lmtt-10'>System </span>renderer with system <span class='ec-lmtt-10'>ConsoleControl </span>assuming it behaves correctly.</li></ul>
     <!-- l. 7851 --><p class='noindent'>The use of <span class='ec-lmtt-10'>BuiltinGraphics </span>is straightforward. For most platforms, it is necessary to enable <span class='ec-lmtt-10'>ProvideConsoleGop </span>and
     set <span class='ec-lmtt-10'>Resolution </span>to <span class='ec-lmtt-10'>Max</span>. The <span class='ec-lmtt-10'>BuiltinText </span>variant is an alternative <span class='ec-lmtt-10'>BuiltinGraphics </span>for some very old and defective
     laptop firmware, which can only draw in <span class='ec-lmtt-10'>Text </span>mode.
     </p><!-- l. 7857 --><p class='noindent'>The use of <span class='ec-lmtt-10'>System </span>protocols is more complicated. Typically, the preferred setting is <span class='ec-lmtt-10'>SystemGraphics </span>or <span class='ec-lmtt-10'>SystemText</span>.
     Enabling <span class='ec-lmtt-10'>ProvideConsoleGop</span>, setting <span class='ec-lmtt-10'>Resolution </span>to <span class='ec-lmtt-10'>Max</span>, enabling <span class='ec-lmtt-10'>ReplaceTabWithSpace </span>is useful on almost all
     platforms. <span class='ec-lmtt-10'>SanitiseClearScreen</span>, <span class='ec-lmtt-10'>IgnoreTextInGraphics</span>, and <span class='ec-lmtt-10'>ClearScreenOnModeSwitch </span>are more specific, and their
     use depends on the firmware.
     </p><!-- l. 7865 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Some Macs, such as the <span class='ec-lmtt-10'>MacPro5,1</span>, may have incompatible console output when using modern GPUs, and thus
     only <span class='ec-lmtt-10'>BuiltinGraphics </span>may work for them in such cases. NVIDIA GPUs may require additional <a href='https://github.com/acidanthera/bugtracker/issues/1280'>firmware
     upgrades</a>.
     </p></li>
<li class='enumerate' id='x1-84004x2'>
     <!-- l. 7871 --><p class='noindent'><span class='ec-lmtt-10'>ConsoleMode</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Maintain current console mode)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets console output mode as specified with the <span class='ec-lmtt-10'>WxH </span>(e.g. <span class='ec-lmtt-10'>80x24</span>) formatted string.
     </p><!-- l. 7877 --><p class='noindent'>Set to <span class='ec-lmtt-10'>Max </span>to attempt using the largest available console mode. This option is currently ignored as the <span class='ec-lmtt-10'>Builtin </span>text
                                                                                                  
                                                                                                  
     renderer only supports one console mode.
     </p><!-- l. 7881 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This field is best left empty on most types of firmware.
     </p></li>
<li class='enumerate' id='x1-84006x3'>
     <!-- l. 7884 --><p class='noindent'><span class='ec-lmtt-10'>Resolution</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty (Maintain current screen resolution)<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Sets console output screen resolution.
</p>
         <ul class='itemize1'>
         <li class='itemize'>Set to <span class='ec-lmtt-10'>WxH@Bpp </span>(e.g. <span class='ec-lmtt-10'>1920x1080@32</span>) or <span class='ec-lmtt-10'>WxH </span>(e.g. <span class='ec-lmtt-10'>1920x1080</span>) formatted string to request custom resolution
         from GOP if available.
         </li>
         <li class='itemize'>Set to <span class='ec-lmtt-10'>Max </span>to attempt using the largest available screen resolution.</li></ul>
     <!-- l. 7898 --><p class='noindent'>On HiDPI screens <span class='ec-lmtt-10'>APPLE_VENDOR_VARIABLE_GUID UIScale </span>NVRAM variable may need to be set to <span class='ec-lmtt-10'>02 </span>to enable HiDPI
     scaling in <span class='ec-lmtt-10'>Builtin </span>text renderer, FileVault 2 UEFI password interface, and boot screen logo. Refer to the <a href='#recommended-variables'>Recommended
     Variables</a> section for details.
     </p><!-- l. 7904 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This will fail when console handle has no GOP protocol. When the firmware does not provide it, it can be added
     with <span class='ec-lmtt-10'>ProvideConsoleGop </span>set to <span class='ec-lmtt-10'>true</span>.
     </p></li>
<li class='enumerate' id='x1-84008x4'>
     <!-- l. 7909 --><p class='noindent'><span class='ec-lmtt-10'>ForceResolution</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Forces <span class='ec-lmtt-10'>Resolution </span>to be set in cases where the desired resolution is not available by default, such as on
     legacy Intel GMA and first generation Intel HD Graphics (Ironlake/Arrandale). Setting <span class='ec-lmtt-10'>Resolution </span>to <span class='ec-lmtt-10'>Max </span>will try to
     pull the largest available resolution from the connected display’s EDID.
     </p><!-- l. 7918 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option depends on the <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Include/Acidanthera/Protocol/OcForceResolution.h'><span class='ec-lmtt-10'>OC_FORCE_RESOLUTION_PROTOCOL</span></a> protocol being present. This protocol is
     currently only supported by <span class='ec-lmtt-10'>OpenDuetPkg</span>. The <span class='ec-lmtt-10'>OpenDuetPkg </span>implementation currently only supports Intel
     iGPUs.
     </p></li>
<li class='enumerate' id='x1-84010x5'>
     <!-- l. 7923 --><p class='noindent'><span class='ec-lmtt-10'>ClearScreenOnModeSwitch</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware only clear part of the screen when switching from graphics to text mode, leaving a
     fragment of previously drawn images visible. This option fills the entire graphics screen with black colour before switching
     to text mode.
     </p><!-- l. 7931 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option only applies to <span class='ec-lmtt-10'>System </span>renderer.
     </p></li>
<li class='enumerate' id='x1-84012x6'>
     <!-- l. 7934 --><p class='noindent'><span class='ec-lmtt-10'>DirectGopRendering</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Use builtin graphics output protocol renderer for console.
     </p><!-- l. 7939 --><p class='noindent'>On certain firmware, such as on the <span class='ec-lmtt-10'>MacPro5,1</span>, this may provide better performance or fix rendering issues. However,
     this option is not recommended unless there is an obvious benefit as it may result in issues such as slower
     scrolling.
     </p><!-- l. 7943 --><p class='noindent'>This renderer fully supports <span class='ec-lmtt-10'>AppleEg2Info </span>protocol and will provide screen rotation for all EFI applications. In order to
     provide seamless rotation compatibility with <span class='ec-lmtt-10'>EfiBoot</span>, builtin <span class='ec-lmtt-10'>AppleFramebufferInfo </span>should also be used, i.e. it may
     need to be overridden on Mac EFI.
     </p></li>
<li class='enumerate' id='x1-84014x7'>
     <!-- l. 7949 --><p class='noindent'><span class='ec-lmtt-10'>GopPassThrough</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Disabled</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide GOP protocol instances on top of UGA protocol instances.
     </p><!-- l. 7954 --><p class='noindent'>This option provides the GOP protocol via a UGA-based proxy for firmware that do not implement the protocol. The
     supported values for the option are as follows:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Enabled </span>— provide GOP for all UGA protocols.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Apple </span>— provide GOP for <span class='ec-lmtt-10'>AppleFramebufferInfo</span>-enabled protocols.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Disabled </span>— do not provide GOP.</li></ul>
     <!-- l. 7965 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option requires <span class='ec-lmtt-10'>ProvideConsoleGop </span>to be enabled.
     </p></li>
<li class='enumerate' id='x1-84016x8'>
     <!-- l. 7968 --><p class='noindent'><span class='ec-lmtt-10'>IgnoreTextInGraphics</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware output text onscreen in both graphics and text mode. This is typically unexpected
     as random text may appear over graphical images and cause UI corruption. Setting this option to <span class='ec-lmtt-10'>true </span>will discard all
     text output when console control is in a different mode from <span class='ec-lmtt-10'>Text</span>.
     </p><!-- l. 7976 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option only applies to the <span class='ec-lmtt-10'>System </span>renderer.
     </p></li>
<li class='enumerate' id='x1-84018x9'>
     <!-- l. 7979 --><p class='noindent'><span class='ec-lmtt-10'>ReplaceTabWithSpace</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware do not print tab characters or everything that follows them, causing difficulties in
     using the UEFI Shell’s builtin text editor to edit property lists and other documents. This option makes the console
     output spaces instead of tabs.
     </p><!-- l. 7987 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option only applies to <span class='ec-lmtt-10'>System </span>renderer.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-84020x10'>
     <!-- l. 7990 --><p class='noindent'><span class='ec-lmtt-10'>ProvideConsoleGop</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Ensure GOP (Graphics Output Protocol) on console handle.
     </p><!-- l. 7995 --><p class='noindent'>macOS bootloader requires GOP or UGA (for 10.4 EfiBoot) to be present on console handle, yet the exact location of the
     graphics protocol is not covered by the UEFI specification. This option will ensure GOP and UGA, if present, are
     available on the console handle.
     </p><!-- l. 8000 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option will also replace incompatible implementations of GOP on the console handle, as may be the case on
     the <span class='ec-lmtt-10'>MacPro5,1 </span>when using modern GPUs.
     </p></li>
<li class='enumerate' id='x1-84022x11'>
     <!-- l. 8004 --><p class='noindent'><span class='ec-lmtt-10'>ReconnectGraphicsOnConnect</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reconnect all graphics drivers during driver connection.
     </p><!-- l. 8009 --><p class='noindent'>On certain firmware, it may be desireable to use an alternative graphics driver, for example BiosVideo.efi,
     providing better screen resolution options on legacy machines, or a driver supporting <span class='ec-lmtt-10'>ForceResolution</span>. This
     option attempts to disconnect all currently connected graphics drivers before connecting newly loaded
     drivers.
     </p><!-- l. 8015 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option requires <span class='ec-lmtt-10'>ConnectDrivers </span>to be enabled.
     </p></li>
<li class='enumerate' id='x1-84024x12'>
     <!-- l. 8018 --><p class='noindent'><span class='ec-lmtt-10'>ReconnectOnResChange</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Reconnect console controllers after changing screen resolution.
     </p><!-- l. 8023 --><p class='noindent'>On certain firmware, the controllers that produce the console protocols (simple text out) must be reconnected
     when the screen resolution is changed via GOP. Otherwise, they will not produce text based on the new
     resolution.
     </p><!-- l. 8027 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: On several boards this logic may result in black screen when launching OpenCore from Shell and thus it is
     optional. In versions prior to 0.5.2 this option was mandatory and not configurable. Please do not use this unless
     required.
     </p></li>
<li class='enumerate' id='x1-84026x13'>
     <!-- l. 8032 --><p class='noindent'><span class='ec-lmtt-10'>SanitiseClearScreen</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware reset screen resolutions to a failsafe value (such as <span class='ec-lmtt-10'>1024x768</span>) on the
     attempts to clear screen contents when large display (e.g. 2K or 4K) is used. This option attempts to apply a
     workaround.
     </p><!-- l. 8040 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option only applies to the <span class='ec-lmtt-10'>System </span>renderer. On all known affected systems, <span class='ec-lmtt-10'>ConsoleMode </span>must be set to an
     empty string for this option to work.
     </p></li>
                                                                                                  
                                                                                                  
<li class='enumerate' id='x1-84028x14'>
     <!-- l. 8045 --><p class='noindent'><span class='ec-lmtt-10'>UIScale</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span>, 8 bit<br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: User interface scaling factor.
     </p><!-- l. 8050 --><p class='noindent'>Corresponds to <span class='ec-lmtt-10'>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:UIScale </span>variable. </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>1 </span>— 1x scaling, corresponds to normal displays.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>2 </span>— 2x scaling, corresponds to HiDPI displays.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>-1 </span>— leaves the current variable unchanged.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>0 </span>— automatically chooses scaling based on the current resolution.</li></ul>
     <!-- l. 8059 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: Automatic scale factor detection works on the basis of total pixel area and may fail on small HiDPI displays, in
     which case the value may be manually managed using the NVRAM section.
     </p><!-- l. 8062 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: When switching from manually specified NVRAM variable to this preference an NVRAM reset may be
     needed.
     </p></li>
<li class='enumerate' id='x1-84030x15'>
     <!-- l. 8065 --><p class='noindent'><span class='ec-lmtt-10'>UgaPassThrough</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Provide UGA protocol instances on top of GOP protocol instances.
     </p><!-- l. 8070 --><p class='noindent'>Some types of firmware do not implement the legacy UGA protocol but this may be required for screen output by older
     EFI applications such as EfiBoot from 10.4.
</p>
     </li></ol>
<!-- l. 8076 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='protocoloverrides-properties'><span class='titlemark'>11.16   </span> <a id='x1-8500011.16'></a>ProtocolOverrides Properties</h4>
<!-- l. 8078 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-85002x1'>
     <!-- l. 8081 --><p class='noindent'><span class='ec-lmtt-10'>AppleAudio</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces Apple audio protocols with builtin versions.
     </p><!-- l. 8087 --><p class='noindent'>Apple audio protocols allow OpenCore and the macOS bootloader to play sounds and signals for screen reading
     or audible error reporting. Supported protocols are beep generation and VoiceOver. The VoiceOver protocol is
     only provided natively by Gibraltar machines (T2), however versions of macOS which support VoiceOver will
     see and use the implementation provided by OpenCore, on screens such as FileVault 2 unlock. VoiceOver is not
                                                                                                  
                                                                                                  
     supported before macOS High Sierra (10.13). Older macOS versions use the AppleHDA protocol (which is not
     currently implemented) instead.
     </p><!-- l. 8096 --><p class='noindent'>Only one set of audio protocols can be available at a time, so this setting should be enabled in order to enable
     audio playback in the OpenCore user interface on Mac systems implementing some of these protocols.
     </p><!-- l. 8100 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The backend audio driver needs to be configured in <span class='ec-lmtt-10'>UEFI Audio </span>section for these protocols to be able to
     stream audio.
     </p></li>
<li class='enumerate' id='x1-85004x2'>
     <!-- l. 8104 --><p class='noindent'><span class='ec-lmtt-10'>AppleBootPolicy</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple Boot Policy protocol with a builtin version. This may be used to ensure APFS
     compatibility on VMs and legacy Macs.
     </p><!-- l. 8110 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option is advisable on certain Macs, such as the <span class='ec-lmtt-10'>MacPro5,1</span>, that are APFS compatible but on which
     the Apple Boot Policy protocol has recovery detection issues.
     </p></li>
<li class='enumerate' id='x1-85006x3'><span class='ec-lmtt-10'>AppleDebugLog</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple Debug Log protocol with a builtin version.
     </li>
<li class='enumerate' id='x1-85008x4'>
     <!-- l. 8122 --><p class='noindent'><span class='ec-lmtt-10'>AppleEg2Info</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple EFI Graphics 2 protocol with a builtin version.
     </p><!-- l. 8128 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This protocol allows newer <span class='ec-lmtt-10'>EfiBoot </span>versions (at least 10.15) to expose screen rotation to macOS. Refer
     to <span class='ec-lmtt-10'>ForceDisplayRotationInEFI </span>variable description on how to set screen rotation angle.
     </p><!-- l. 8132 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: On systems without native support for <span class='ec-lmtt-10'>ForceDisplayRotationInEFI</span>, <span class='ec-lmtt-10'>DirectGopRendering=true </span>is
     also required for this setting to have an effect.
     </p></li>
<li class='enumerate' id='x1-85010x5'>
     <!-- l. 8137 --><p class='noindent'><span class='ec-lmtt-10'>AppleFramebufferInfo</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple Framebuffer Info protocol with a builtin version. This may be used to override
     framebuffer information on VMs and legacy Macs to improve compatibility with legacy EfiBoot such as the one
     in macOS 10.4.
     </p><!-- l. 8144 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: The current implementation of this property results in it only being active when GOP is available (it is
     always equivalent to <span class='ec-lmtt-10'>false </span>otherwise).
     </p></li>
<li class='enumerate' id='x1-85012x6'><span class='ec-lmtt-10'>AppleImageConversion</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple Image Conversion protocol with a builtin version.
     </li>
<li class='enumerate' id='x1-85014x7'><span class='ec-lmtt-10'>AppleImg4Verification</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple IMG4 Verification protocol with a builtin version. This protocol is used to
     verify <span class='ec-lmtt-10'>im4m </span>manifest files used by Apple Secure Boot.
     </li>
<li class='enumerate' id='x1-85016x8'><span class='ec-lmtt-10'>AppleKeyMap</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces Apple Key Map protocols with builtin versions.
     </li>
<li class='enumerate' id='x1-85018x9'>
     <!-- l. 8170 --><p class='noindent'><span class='ec-lmtt-10'>AppleRtcRam</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple RTC RAM protocol with a builtin version.
     </p><!-- l. 8176 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Builtin version of Apple RTC RAM protocol may filter out I/O attempts to certain RTC memory addresses.
     The list of addresses can be specified in <span class='ec-lmtt-10'>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:rtc-blacklist </span>variable as
     a data array.
     </p></li>
<li class='enumerate' id='x1-85020x10'><span class='ec-lmtt-10'>AppleSecureBoot</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple Secure Boot protocol with a builtin version.
     </li>
<li class='enumerate' id='x1-85022x11'>
     <!-- l. 8189 --><p class='noindent'><span class='ec-lmtt-10'>AppleSmcIo</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple SMC I/O protocol with a builtin version.
     </p><!-- l. 8195 --><p class='noindent'>This protocol replaces the legacy <span class='ec-lmtt-10'>VirtualSmc </span>UEFI driver, and is compatible with any SMC kernel extension.
     However, in case the <span class='ec-lmtt-10'>FakeSMC </span>kernel extension is used, manual NVRAM key variable addition may be needed.
     </p></li>
<li class='enumerate' id='x1-85024x12'><span class='ec-lmtt-10'>AppleUserInterfaceTheme</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Apple User Interface Theme protocol with a builtin version.
     </li>
<li class='enumerate' id='x1-85026x13'>
     <!-- l. 8207 --><p class='noindent'><span class='ec-lmtt-10'>DataHub</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Data Hub protocol with a builtin version.
     </p><!-- l. 8212 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This will discard all previous entries if the protocol was already installed, so all properties required for the
     safe operation of the system must be specified in the configuration file.
     </p></li>
<li class='enumerate' id='x1-85028x14'>
     <!-- l. 8217 --><p class='noindent'><span class='ec-lmtt-10'>DeviceProperties</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the Device Property protocol with a builtin version. This may be used to ensure full
     compatibility on VMs and legacy Macs.
     </p><!-- l. 8223 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This will discard all previous entries if the protocol was already installed, so all properties required for safe
     operation of the system must be specified in the configuration file.
     </p></li>
<li class='enumerate' id='x1-85030x15'>
     <!-- l. 8228 --><p class='noindent'><span class='ec-lmtt-10'>FirmwareVolume</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Wraps Firmware Volume protocols, or installs a new version, to support custom cursor images for
     FileVault 2. Set to <span class='ec-lmtt-10'>true </span>to ensure FileVault 2 compatibility on anything other than on VMs and legacy Macs.
     </p><!-- l. 8235 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Several virtual machines, including VMware, may have corrupted cursor images in HiDPI mode and thus,
     may also require enabling this setting.
     </p></li>
<li class='enumerate' id='x1-85032x16'><span class='ec-lmtt-10'>HashServices</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Replaces  Hash  Services  protocols  with  builtin  versions.  Set  to  <span class='ec-lmtt-10'>true </span>to  ensure  FileVault  2
     compatibility on platforms with defective SHA-1 hash implementations. This can be determined by an invalid
     cursor size when <span class='ec-lmtt-10'>UIScale </span>is set to <span class='ec-lmtt-10'>02</span>. Platforms earlier than APTIO V (Haswell and older) are typically affected.
     </li>
<li class='enumerate' id='x1-85034x17'><span class='ec-lmtt-10'>OSInfo</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Replaces the OS Info protocol with a builtin version. This protocol is typically used by the firmware
     and other applications to receive notifications from the macOS bootloader.
     </li>
<li class='enumerate' id='x1-85036x18'><span class='ec-lmtt-10'>UnicodeCollation</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>:  Replaces  unicode  collation  services  with  builtin  versions.  Set  to  <span class='ec-lmtt-10'>true </span>to  ensure  UEFI  Shell
     compatibility  on  platforms  with  defective  unicode  collation  implementations.  Legacy  Insyde  and  APTIO
     platforms on Ivy Bridge, and earlier, are typically affected.
</li></ol>
<!-- l. 8267 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='quirks-properties3'><span class='titlemark'>11.17   </span> <a id='x1-8600011.17'></a>Quirks Properties</h4>
<!-- l. 8269 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-86002x1'>
     <!-- l. 8272 --><p class='noindent'><span class='ec-lmtt-10'>ActivateHpetSupport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Activates HPET support.
     </p><!-- l. 8277 --><p class='noindent'>Older boards like ICH6 may not always have HPET setting in the firmware preferences, this option tries to force
     enable it.
     </p></li>
<li class='enumerate' id='x1-86004x2'>
     <!-- l. 8281 --><p class='noindent'><span class='ec-lmtt-10'>EnableVectorAcceleration</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable AVX vector acceleration of SHA-512 and SHA-384 hashing algorithms.
     </p><!-- l. 8286 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This option may cause issues on certain laptop firmwares, including Lenovo.
     </p></li>
<li class='enumerate' id='x1-86006x3'>
     <!-- l. 8289 --><p class='noindent'><span class='ec-lmtt-10'>EnableVmx</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enable Intel virtual machine extensions.
     </p><!-- l. 8294 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Required to allow virtualization in Windows on some Mac hardware. VMX is enabled or disabled and
     locked by BIOS before OpenCore starts on most firmware. Use BIOS to enable virtualization where possible.
     </p></li>
<li class='enumerate' id='x1-86008x4'>
     <!-- l. 8299 --><p class='noindent'><span class='ec-lmtt-10'>DisableSecurityPolicy</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Disable platform security policy.
     </p><!-- l. 8304 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This setting disables various security features of the firmware, defeating the purpose of any kind of Secure
     Boot. Do NOT enable if using UEFI Secure Boot.
                                                                                                  
                                                                                                  
     </p></li>
<li class='enumerate' id='x1-86010x5'>
     <!-- l. 8309 --><p class='noindent'><span class='ec-lmtt-10'>ExitBootServicesDelay</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Adds delay in microseconds after <span class='ec-lmtt-10'>EXIT_BOOT_SERVICES </span>event.
     </p><!-- l. 8315 --><p class='noindent'>This is a very rough workaround to circumvent the <span class='ec-lmtt-10'>Still waiting for root device </span>message on some APTIO
     IV firmware (ASUS Z87-Pro) particularly when using FileVault 2. It appears that for some reason, they execute
     code in parallel to <span class='ec-lmtt-10'>EXIT_BOOT_SERVICES</span>, which results in the SATA controller being inaccessible from macOS. A
     better approach is required and Acidanthera is open to suggestions. Expect 3 to 5 seconds to be adequate when
     this quirk is needed.
     </p></li>
<li class='enumerate' id='x1-86012x6'>
     <!-- l. 8322 --><p class='noindent'><span class='ec-lmtt-10'>ForceOcWriteFlash</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Enables writing to flash memory for all OpenCore-managed NVRAM system variables.
     </p><!-- l. 8327 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This value should be disabled on most types of firmware but is left configurable to account for firmware
     that may have issues with volatile variable storage overflows or similar. Boot issues across multiple OSes can be
     observed on e.g. Lenovo Thinkpad T430 and T530 without this quirk. Apple variables related to Secure Boot
     and hibernation are exempt from this for security reasons. Furthermore, some OpenCore variables are exempt
     for different reasons, such as the boot log due to an available user option, and the TSC frequency due to timing
     issues. When toggling this option, a NVRAM reset may be required to ensure full functionality.
     </p></li>
<li class='enumerate' id='x1-86014x7'>
     <!-- l. 8338 --><p class='noindent'><span class='ec-lmtt-10'>ForgeUefiSupport</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Implement partial UEFI 2.x support on EFI 1.x firmware.
     </p><!-- l. 8343 --><p class='noindent'>This setting allows running some software written for UEFI 2.x firmware like NVIDIA GOP Option ROMs on
     hardware with older EFI 1.x firmware like <span class='ec-lmtt-10'>MacPro5,1</span>.
     </p></li>
<li class='enumerate' id='x1-86016x8'>
     <!-- l. 8347 --><p class='noindent'><span class='ec-lmtt-10'>IgnoreInvalidFlexRatio</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware (such as APTIO IV) may contain invalid values in the <span class='ec-lmtt-10'>MSR_FLEX_RATIO</span>
     (<span class='ec-lmtt-10'>0x194</span>) MSR register. These values may cause macOS boot failures on Intel platforms.
     </p><!-- l. 8354 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: While the option is not expected to harm unaffected firmware, its use is recommended only when specifically
     required.
     </p></li>
<li class='enumerate' id='x1-86018x9'><span class='ec-lmtt-10'>ReleaseUsbOwnership</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Attempt to detach USB controller ownership from the firmware driver. While most types of
                                                                                                  
                                                                                                  
     firmware manage to do this properly, or at least have an option for this, some do not. As a result, the operating
     system may freeze upon boot. Not recommended unless specifically required.
     </li>
<li class='enumerate' id='x1-86020x10'>
     <!-- l. 8367 --><p class='noindent'><span class='ec-lmtt-10'>ReloadOptionRoms</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Query PCI devices and reload their Option ROMs if available.
     </p><!-- l. 8372 --><p class='noindent'>For example, this option allows reloading NVIDIA GOP Option ROM on older Macs after the firmware version
     is upgraded via <span class='ec-lmtt-10'>ForgeUefiSupport</span>.
     </p></li>
<li class='enumerate' id='x1-86022x11'>
     <!-- l. 8376 --><p class='noindent'><span class='ec-lmtt-10'>RequestBootVarRouting</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Request redirect of all <span class='ec-lmtt-10'>Boot </span>prefixed variables from <span class='ec-lmtt-10'>EFI_GLOBAL_VARIABLE_GUID </span>to <br class='newline' /><span class='ec-lmtt-10'>OC_VENDOR_VARIABLE_GUID</span>.
     </p><!-- l. 8382 --><p class='noindent'>This quirk requires <span class='ec-lmtt-10'>OC_FIRMWARE_RUNTIME </span>protocol implemented in <span class='ec-lmtt-10'>OpenRuntime.efi</span>. The quirk lets default
     boot entry preservation at times when the firmware deletes incompatible boot entries. In summary, this quirk is
     required to reliably use the <a href='https://support.apple.com/HT202796'>Startup Disk</a> preference pane in firmware that is not compatible with macOS boot
     entries by design.
     </p><!-- l. 8389 --><p class='noindent'>By redirecting <span class='ec-lmtt-10'>Boot </span>prefixed variables to a separate GUID namespace with the help of <span class='ec-lmtt-10'>RequestBootVarRouting </span>quirk we
     achieve multiple goals: </p>
         <ul class='itemize1'>
         <li class='itemize'>Operating systems are jailed and only controlled by OpenCore boot environment to enhance security.
         </li>
         <li class='itemize'>Operating systems do not mess with OpenCore boot priority, and guarantee fluent updates and hibernation
         wakes for cases that require reboots with OpenCore in the middle.
         </li>
         <li class='itemize'>Potentially incompatible boot entries, such as macOS entries, are not deleted or corrupted in any way.</li></ul>
     </li>
<li class='enumerate' id='x1-86024x12'>
     <!-- l. 8403 --><p class='noindent'><span class='ec-lmtt-10'>ResizeGpuBars</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>-1</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Configure GPU PCI BAR sizes.
     </p><!-- l. 8408 --><p class='noindent'>This quirk sets GPU PCI BAR sizes as specified or chooses the largest available below the <span class='ec-lmtt-10'>ResizeGpuBars </span>value. The
     specified value follows PCI Resizable BAR spec. Use <span class='ec-lmtt-10'>0 </span>for 1 MB, <span class='ec-lmtt-10'>1 </span>for 2 MB, <span class='ec-lmtt-10'>2 </span>for 4 MB, and so on up to <span class='ec-lmtt-10'>19 </span>for 512
     GB.
     </p><!-- l. 8414 --><p class='noindent'>Resizable BAR technology allows to ease PCI device programming by mapping a configurable memory
     region, BAR, into CPU address space (e.g. VRAM to RAM) as opposed to a fixed memory region. This
     technology is necessary, because one cannot map the largest memory region by default, for the reasons
     of backwards compatibility with older hardware not supporting 64-bit BARs. Consequentially devices
     of the last decade use BARs up to 256 MB by default (4 remaining bits are used by other data) but
     generally allow resizing them to both smaller and larger powers of two (e.g. from 1 MB up to VRAM
                                                                                                  
                                                                                                  
     size).
     </p><!-- l. 8423 --><p class='noindent'>Operating systems targeting x86 platforms generally do not control PCI address space, letting UEFI firmware decide on
     the BAR addresses and sizes. This illicit practice resulted in Resizable BAR technology being unused
     up until 2020 despite being standardised in 2008 and becoming widely available in the hardware soon
     after.
     </p><!-- l. 8428 --><p class='noindent'>Modern UEFI firmware allow the use of Resizable BAR technology but generally restrict the configurable options to
     failsafe default (<span class='ec-lmtt-10'>OFF</span>) and maximum available (<span class='ec-lmtt-10'>ON</span>). This quirk allows to fine-tune this value for testing and development
     purposes.
     </p><!-- l. 8433 --><p class='noindent'>Consider a GPU with 2 BARs: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>BAR0 </span>supports sizes from 256 MB to 8 GB. Its value is 4 GB.
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BAR1 </span>supports sizes from 2 MB to 256 MB. Its value is 256 MB.</li></ul>
     <!-- l. 8440 --><p class='noindent'><span class='ec-lmri-10'>Example 1</span>: Setting <span class='ec-lmtt-10'>ResizeGpuBars </span>to 1 GB will change <span class='ec-lmtt-10'>BAR0 </span>to 1 GB and leave <span class='ec-lmtt-10'>BAR1 </span>unchanged. <br class='newline' /><span class='ec-lmri-10'>Example 2</span>: Setting <span class='ec-lmtt-10'>ResizeGpuBars </span>to 1 MB will change <span class='ec-lmtt-10'>BAR0 </span>to 256 MB and <span class='ec-lmtt-10'>BAR0 </span>to 2 MB. <br class='newline' /><span class='ec-lmri-10'>Example 3</span>: Setting <span class='ec-lmtt-10'>ResizeGpuBars </span>to 16 GB will change <span class='ec-lmtt-10'>BAR0 </span>to 8 GB and leave <span class='ec-lmtt-10'>BAR1 </span>unchanged.
     </p><!-- l. 8449 --><p class='noindent'><span class='ec-lmri-10'>Note 1</span>: This quirk shall not be used to workaround macOS limitation to address BARs over 1 GB. <span class='ec-lmtt-10'>ResizeAppleGpuBars</span>
     should be used instead.
     </p><!-- l. 8452 --><p class='noindent'><span class='ec-lmri-10'>Note 2</span>: While this quirk can increase GPU PCI BAR sizes, this will not work on most firmware as is, because the quirk
     does not relocate BARs in memory, and they will likely overlap. Contributions to improve this feature are
     welcome.
     </p></li>
<li class='enumerate' id='x1-86026x13'>
     <!-- l. 8457 --><p class='noindent'><span class='ec-lmtt-10'>TscSyncTimeout</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Attempts to perform TSC synchronisation with a specified timeout.
     </p><!-- l. 8462 --><p class='noindent'>The primary purpose of this quirk is to enable early bootstrap TSC synchronisation on some server and laptop models
     when running a debug XNU kernel. For the debug kernel the TSC needs to be kept in sync across the
     cores before any kext could kick in rendering all other solutions problematic. The timeout is specified in
     microseconds and depends on the amount of cores present on the platform, the recommended starting value is
     <span class='ec-lmtt-10'>500000</span>.
     </p><!-- l. 8468 --><p class='noindent'>This is an experimental quirk, which should only be used for the aforementioned problem. In all other cases, the quirk
     may render the operating system unstable and is not recommended. The recommended solution in the other cases is to
     install a kernel extension such as <a href='https://github.com/RehabMan/VoodooTSCSync'>VoodooTSCSync</a>, <a href='https://github.com/interferenc/TSCAdjustReset'>TSCAdjustReset</a>, or <a href='https://github.com/lvs1974/CpuTscSync'>CpuTscSync</a> (a more specialised variant of
     VoodooTSCSync for newer laptops).
     </p><!-- l. 8476 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This quirk cannot replace the kernel extension because it cannot operate in ACPI S3 (sleep wake) mode and
     because the UEFI firmware only provides very limited multicore support which prevents precise updates of the MSR
     registers.
     </p></li>
<li class='enumerate' id='x1-86028x14'>
     <!-- l. 8481 --><p class='noindent'><span class='ec-lmtt-10'>UnblockFsConnect</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Some types of firmware block partition handles by opening them in <span class='ec-lmtt-10'>By Driver </span>mode, resulting in an
     inability to install File System protocols.
                                                                                                  
                                                                                                  
     </p><!-- l. 8487 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: This quirk is useful in cases where unsuccessful drive detection results in an absence of boot entries.
</p>
     </li></ol>
<!-- l. 8492 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='reservedmemory-properties'><span class='titlemark'>11.18   </span> <a id='x1-8700011.18'></a>ReservedMemory Properties</h4>
<!-- l. 8494 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-87002x1'>
     <!-- l. 8497 --><p class='noindent'><span class='ec-lmtt-10'>Address</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Start address of the reserved memory region, which should be allocated as reserved effectively
     marking the memory of this type inaccessible to the operating system.
     </p><!-- l. 8503 --><p class='noindent'>The addresses written here must be part of the memory map, have a <span class='ec-lmtt-10'>EfiConventionalMemory </span>type, and be
     page-aligned (4 KBs).
     </p><!-- l. 8506 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: Some types of firmware may not allocate memory areas used by S3 (sleep) and S4 (hibernation) code unless
     CSM is enabled causing wake failures. After comparing the memory maps with CSM disabled and enabled, these
     areas can be found in the lower memory and can be fixed up by doing the reservation. Refer to the <span class='ec-lmtt-10'>Sample.plist</span>
     file for details.
     </p></li>
<li class='enumerate' id='x1-87004x2'><span class='ec-lmtt-10'>Comment</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: Empty<br class='newline' /><span class='ec-lmbx-10'>Description</span>: Arbitrary ASCII string used to provide human readable reference for the entry. Whether this value
     is used is implementation defined.
     </li>
<li class='enumerate' id='x1-87006x3'><span class='ec-lmtt-10'>Size</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist integer</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>0</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Size of the reserved memory region, must be page-aligned (4 KBs).
     </li>
<li class='enumerate' id='x1-87008x4'>
     <!-- l. 8525 --><p class='noindent'><span class='ec-lmtt-10'>Type</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist string</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>Reserved</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: Memory region type matching the UEFI specification memory descriptor types. Mapping:
</p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>Reserved </span>— <span class='ec-lmtt-10'>EfiReservedMemoryType</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>LoaderCode </span>— <span class='ec-lmtt-10'>EfiLoaderCode</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>LoaderData </span>— <span class='ec-lmtt-10'>EfiLoaderData</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BootServiceCode </span>— <span class='ec-lmtt-10'>EfiBootServicesCode</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>BootServiceData </span>— <span class='ec-lmtt-10'>EfiBootServicesData</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>RuntimeCode </span>— <span class='ec-lmtt-10'>EfiRuntimeServicesCode</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>RuntimeData </span>— <span class='ec-lmtt-10'>EfiRuntimeServicesData</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Available </span>— <span class='ec-lmtt-10'>EfiConventionalMemory</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>Persistent </span>— <span class='ec-lmtt-10'>EfiPersistentMemory</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>UnusableMemory </span>— <span class='ec-lmtt-10'>EfiUnusableMemory</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ACPIReclaimMemory </span>— <span class='ec-lmtt-10'>EfiACPIReclaimMemory</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ACPIMemoryNVS </span>— <span class='ec-lmtt-10'>EfiACPIMemoryNVS</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>MemoryMappedIO </span>— <span class='ec-lmtt-10'>EfiMemoryMappedIO</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>MemoryMappedIOPortSpace </span>— <span class='ec-lmtt-10'>EfiMemoryMappedIOPortSpace</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>PalCode </span>— <span class='ec-lmtt-10'>EfiPalCode</span></li></ul>
     </li>
<li class='enumerate' id='x1-87010x5'><span class='ec-lmtt-10'>Enabled</span><br class='newline' /><span class='ec-lmbx-10'>Type</span>: <span class='ec-lmtt-10'>plist boolean</span><br class='newline' /><span class='ec-lmbx-10'>Failsafe</span>: <span class='ec-lmtt-10'>false</span><br class='newline' /><span class='ec-lmbx-10'>Description</span>: This region will not be reserved unless set to <span class='ec-lmtt-10'>true</span>.
</li></ol>
<!-- l. 8558 --><p class='noindent'>
                                                                                                  
                                                                                                  
</p>
<h3 class='sectionHead' id='troubleshooting'><span class='titlemark'>12   </span> <a id='x1-8800012'></a>Troubleshooting</h3>
<!-- l. 8560 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='legacy-apple-os'><span class='titlemark'>12.1   </span> <a id='x1-8900012.1'></a>Legacy Apple OS</h4>
<!-- l. 8562 --><p class='noindent'>Older operating systems may be more complicated to install, but are sometimes necessary for various reasons. While a
compatible board identifier and CPUID are the obvious requirements for proper functioning of an older operating system, there
are many other less obvious things to consider. This section covers a common set of issues relevant to installing older macOS
operating systems.
</p><!-- l. 8569 --><p class='noindent'>While newer operating systems can be downloaded over the internet, older operating systems did not have
installation media for every minor release. For compatible distributions of such, download a device-specific image
and modify it if necessary. Visit this archived Apple Support <a href='https://web.archive.org/web/20170705003629/https://support.apple.com/en-us/HT204319'>article</a> for a list of the bundled device-specific
builds for legacy operating systems. However, as this may not always be accurate, the latest versions are listed
below.
</p><!-- l. 8577 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='macos-and-'><span class='titlemark'>12.1.1   </span> <a id='x1-9000012.1.1'></a>macOS 10.8 and 10.9</h5>
     <ul class='itemize1'>
     <li class='itemize'>Disk images on these systems use the Apple Partitioning Scheme and require the <span class='ec-lmtt-10'>OpenPartitionDxe </span>driver to
     run DMG recovery and installation (included in OpenDuet). It is possible to set <span class='ec-lmtt-10'>DmgLoading </span>to <span class='ec-lmtt-10'>Disabled </span>to run
     the recovery without DMG loading avoiding the need for <span class='ec-lmtt-10'>OpenPartitionDxe</span>.
     </li>
     <li class='itemize'>Cached  kernel  images  often  do  not  contain  family  drivers  for  networking  (<span class='ec-lmtt-10'>IONetworkingFamily</span>)  or  audio
     (<span class='ec-lmtt-10'>IOAudioFamily</span>) requiring the use of <span class='ec-lmtt-10'>Force </span>loading in order to inject networking or audio drivers.</li></ul>
<!-- l. 8591 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='macos-'><span class='titlemark'>12.1.2   </span> <a id='x1-9100012.1.2'></a>macOS 10.7</h5>
     <ul class='itemize1'>
     <li class='itemize'>All previous issues apply.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SSSE3 </span>support (not to be confused with <span class='ec-lmtt-10'>SSE3 </span>support) is a hard requirement for macOS 10.7 kernel.
     </li>
     <li class='itemize'>Many kexts, including <span class='ec-lmtt-10'>Lilu </span>when 32-bit kernel is used and a lot of <span class='ec-lmtt-10'>Lilu </span>plugins, are unsupported on macOS 10.7
     and older as they require newer kernel APIs, which are not part of the macOS 10.7 SDK.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'>Prior to macOS 10.8 KASLR sliding is not supported, which will result in memory allocation failures on firmware
     that utilise lower memory for their own purposes. Refer to <a href='https://github.com/acidanthera/bugtracker/issues/1125'>acidanthera/bugtracker#1125</a> for tracking.</li></ul>
<!-- l. 8608 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='macos-1'><span class='titlemark'>12.1.3   </span> <a id='x1-9200012.1.3'></a>macOS 10.6</h5>
     <ul class='itemize1'>
     <li class='itemize'>All previous issues apply.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>SSSE3 </span>support is a requirement for macOS 10.6 kernel with 64-bit userspace enabled. This limitation can mostly
     be lifted by enabling the <span class='ec-lmtt-10'>LegacyCommpage </span>quirk.
     </li>
     <li class='itemize'>Last  released  installer  images  for  macOS 10.6  are  macOS 10.6.7  builds  <span class='ec-lmtt-10'>10J3250 </span>(for  <span class='ec-lmtt-10'>MacBookPro8,x</span>)  and
     <span class='ec-lmtt-10'>10J4139 </span>(for <span class='ec-lmtt-10'>iMac12,x</span>), without Xcode). These images are limited to their target model identifiers and have no
     <span class='ec-lmtt-10'>-no_compat_check </span>boot argument support. Modified images (with <span class='ec-lmtt-10'>ACDT </span>suffix) without model restrictions can
     be found <a href='https://archive.org/details/10.6.7-10j3250-disk-images'>here</a> (<a href='https://mega.nz/folder/z5YUhYTb#gA_IRY5KMuYpnNCg7kR3ug'>MEGA Mirror</a>), assuming macOS 10.6 is legally owned. Refer to the <span class='ec-lmtt-10'>DIGEST.txt </span>file for details.
     Note that these are the earliest tested versions of macOS 10.6 with OpenCore.</li></ul>
<!-- l. 8628 --><p class='noindent'>Model checking may also be erased by editing <span class='ec-lmtt-10'>OSInstall.mpkg </span>with e.g. <span class='ec-lmtt-10'>Flat Package Editor </span>by making <span class='ec-lmtt-10'>Distribution</span>
script to always return <span class='ec-lmtt-10'>true </span>in <span class='ec-lmtt-10'>hwbeModelCheck </span>function. Since updating the only file in the image and not corrupting other
files can be difficult and may cause slow booting due to kernel cache date changes, it is recommended to script image rebuilding
as shown below:
</p>
<!-- l. 8635 -->
<pre class='lstlisting' id='listing-17'><span class='label'><a id='x1-92001r1'></a></span><span style='color:#000000'><span class='ec-lmtti-10'>#</span></span><span style='color:#000000'><span class='ec-lmtti-10'>!/</span></span><span style='color:#000000'><span class='ec-lmtti-10'>bin</span></span><span style='color:#000000'><span class='ec-lmtti-10'>/</span></span><span style='color:#000000'><span class='ec-lmtti-10'>bash</span></span> 
<span class='label'><a id='x1-92002r2'></a></span><span style='color:#000000'><span class='ec-lmtti-10'>#</span></span><span style='color:#000000'> <span class='ec-lmtti-10'>Original.dmg </span><span class='ec-lmtti-10'>is </span><span class='ec-lmtti-10'>original </span><span class='ec-lmtti-10'>image, </span><span class='ec-lmtti-10'>OSInstall.mpkg </span><span class='ec-lmtti-10'>is </span><span class='ec-lmtti-10'>patched </span><span class='ec-lmtti-10'>package</span> 
</span><span class='label'><a id='x1-92003r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>mkdir</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>RO</span> 
</span><span class='label'><a id='x1-92004r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>mount </span><span class='ec-lmtt-10'>Original.dmg </span><span class='ec-lmtt-10'>-noverify </span><span class='ec-lmtt-10'>-noautoopen </span><span class='ec-lmtt-10'>-noautoopenrw </span><span class='ec-lmtt-10'>-noautofsck </span><span class='ec-lmtt-10'>-mountpoint </span><span class='ec-lmtt-10'>RO</span> 
</span><span class='label'><a id='x1-92005r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>cp</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>RO/.DS_Store </span><span class='ec-lmtt-10'>DS_STORE</span> 
</span><span class='label'><a id='x1-92006r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>detach </span><span class='ec-lmtt-10'>RO </span><span class='ec-lmtt-10'>-force</span> 
</span><span class='label'><a id='x1-92007r7'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>rm</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-rf </span><span class='ec-lmtt-10'>RO</span> 
</span><span class='label'><a id='x1-92008r8'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>convert </span><span class='ec-lmtt-10'>Original.dmg </span><span class='ec-lmtt-10'>-format </span><span class='ec-lmtt-10'>UDRW </span><span class='ec-lmtt-10'>-o </span><span class='ec-lmtt-10'>ReadWrite.dmg</span> 
</span><span class='label'><a id='x1-92009r9'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>mkdir</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>RW</span> 
</span><span class='label'><a id='x1-92010r10'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>xattr</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-c </span><span class='ec-lmtt-10'>OSInstall.mpkg</span> 
</span><span class='label'><a id='x1-92011r11'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>mount </span><span class='ec-lmtt-10'>ReadWrite.dmg </span><span class='ec-lmtt-10'>-noverify </span><span class='ec-lmtt-10'>-noautoopen </span><span class='ec-lmtt-10'>-noautoopenrw </span><span class='ec-lmtt-10'>-noautofsck </span><span class='ec-lmtt-10'>-mountpoint </span><span class='ec-lmtt-10'>RW</span> 
</span><span class='label'><a id='x1-92012r12'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>cp</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>OSInstall.mpkg </span><span class='ec-lmtt-10'>RW/System/Installation/Packages/OSInstall.mpkg</span> 
</span><span class='label'><a id='x1-92013r13'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>killall</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>Finder </span><span class='ec-lmtt-10'>fseventsd</span> 
</span><span class='label'><a id='x1-92014r14'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>rm</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-rf </span><span class='ec-lmtt-10'>RW/.fseventsd</span> 
</span><span class='label'><a id='x1-92015r15'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>cp</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>DS_STORE </span><span class='ec-lmtt-10'>RW/.DS_Store</span> 
</span><span class='label'><a id='x1-92016r16'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>detach </span><span class='ec-lmtt-10'>RW </span><span class='ec-lmtt-10'>-force</span> 
</span><span class='label'><a id='x1-92017r17'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>rm</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>-rf </span><span class='ec-lmtt-10'>DS_STORE </span><span class='ec-lmtt-10'>RW</span> 
</span><span class='label'><a id='x1-92018r18'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>hdiutil</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>convert </span><span class='ec-lmtt-10'>ReadWrite.dmg </span><span class='ec-lmtt-10'>-format </span><span class='ec-lmtt-10'>UDZO </span><span class='ec-lmtt-10'>-o </span><span class='ec-lmtt-10'>ReadOnly.dmg</span></span></pre>
<!-- l. 8656 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='macos-2'><span class='titlemark'>12.1.4   </span> <a id='x1-9300012.1.4'></a>macOS 10.5</h5>
     <ul class='itemize1'>
     <li class='itemize'>All previous issues apply.
     </li>
     <li class='itemize'>This macOS version does not support <span class='ec-lmtt-10'>x86_64 </span>kernel and requires <span class='ec-lmtt-10'>i386 </span>kernel extensions and patches.
                                                                                                  
                                                                                                  
     </li>
     <li class='itemize'>This macOS version uses the first (V1) version of <span class='ec-lmtt-10'>prelinkedkernel</span>, which has kext symbol tables corrupted by
     the kext tools. This nuance renders <span class='ec-lmtt-10'>prelinkedkernel </span>kext injection impossible in OpenCore. <span class='ec-lmtt-10'>Mkext </span>kext injection
     will still work without noticeable performance drain and will be chosen automatically when <span class='ec-lmtt-10'>KernelCache </span>is set
     to <span class='ec-lmtt-10'>Auto</span>.
     </li>
     <li class='itemize'>Last released installer image for macOS 10.5 is macOS 10.5.7 build <span class='ec-lmtt-10'>9J3050 </span>(for <span class='ec-lmtt-10'>MacBookPro5,3</span>). Unlike the
     others, this image is not limited to the target model identifiers and can be used as is. The original <span class='ec-lmtt-10'>9J3050 </span>image
     can be found <a href='https://archive.org/details/10.5.7-9-j-3050'>here</a> (<a href='https://mega.nz/folder/inRBTarD#zanf7fUbviwz3WHBU5xpCg'>MEGA Mirror</a>), assuming macOS 10.5 is legally owned. Refer to the <span class='ec-lmtt-10'>DIGEST.txt </span>file for
     details. Note that this is the earliest tested version of macOS 10.5 with OpenCore.</li></ul>
<!-- l. 8679 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='macos-3'><span class='titlemark'>12.1.5   </span> <a id='x1-9400012.1.5'></a>macOS 10.4</h5>
     <ul class='itemize1'>
     <li class='itemize'>All previous issues apply.
     </li>
     <li class='itemize'>This  macOS  version  has  a  hard  requirement  to  access  all  the  optional  packages  on  the  second  DVD  disk
     installation media, requiring either two disks or USB media installation.
     </li>
     <li class='itemize'>Last released installer images for macOS 10.4 are macOS 10.4.10 builds <span class='ec-lmtt-10'>8R4061a </span>(for <span class='ec-lmtt-10'>MacBookPro3,1</span>) and
     <span class='ec-lmtt-10'>8R4088 </span>(for <span class='ec-lmtt-10'>iMac7,1</span>)). These images are limited to their target model identifiers as on newer macOS versions.
     Modified <span class='ec-lmtt-10'>8R4088 </span>images (with  <span class='ec-lmtt-10'>ACDT </span>suffix) without model restrictions can be found <a href='https://archive.org/details/10.4.10-8-r-4088-acdt'>here</a> (<a href='https://mega.nz/folder/D3ASzLzA#7sjYXE2X09f6aGjol_C7dg'>MEGA Mirror</a>),
     assuming macOS 10.4 is legally owned. Refer to the <span class='ec-lmtt-10'>DIGEST.txt </span>file for details. Note that these are the earliest
     tested versions of macOS 10.4 with OpenCore.</li></ul>
<!-- l. 8699 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='uefi-secure-boot'><span class='titlemark'>12.2   </span> <a id='x1-9500012.2'></a>UEFI Secure Boot</h4>
<!-- l. 8701 --><p class='noindent'>OpenCore is designed to provide a secure boot chain between firmware and operating system. On most x86 platforms trusted
loading is implemented via <a href='https://en.wikipedia.org/wiki/UEFI_Secure_Boot'>UEFI Secure Boot</a> model. Not only OpenCore fully supports this model, but it also extends its
capabilities to ensure sealed configuration via <a href='#x1-46036x11'>vaulting</a> and provide trusted loading to the operating systems using custom
verification, such as <a href='#x1-46046x13'>Apple Secure Boot</a>. Proper secure boot chain requires several steps and careful configuration of certain
settings as explained below:
</p><!-- l. 8710 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-95002x1'>Enable Apple Secure Boot by setting <span class='ec-lmtt-10'>SecureBootModel </span>to run macOS. Note, that not every macOS is compatible
     with Apple Secure Boot and there are several other restrictions as explained in <a href='#x1-46046x13'>Apple Secure Boot</a> section.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-95004x2'>Disable DMG loading by setting <span class='ec-lmtt-10'>DmgLoading </span>to <span class='ec-lmtt-10'>Disabled </span>if users have concerns of loading old vulnerable DMG
     recoveries. This is <span class='ec-lmbx-10'>not </span>required, but recommended. For the actual tradeoffs see the details in <a href='#x1-46017x5'>DMG loading</a>
     section.
     </li>
<li class='enumerate' id='x1-95006x3'>Make sure that APFS JumpStart functionality restricts the loading of old vulnerable drivers by setting <span class='ec-lmtt-10'>MinDate</span>
     and <span class='ec-lmtt-10'>MinVersion </span>to <span class='ec-lmtt-10'>0</span>. More details are provided in <a href='#apfs-properties'>APFS JumpStart</a> section. An alternative is to install <span class='ec-lmtt-10'>apfs.efi</span>
     driver manually.
     </li>
<li class='enumerate' id='x1-95008x4'>Make sure that <span class='ec-lmtt-10'>Force </span>driver loading is not needed and all the operating systems are still bootable.
     </li>
<li class='enumerate' id='x1-95010x5'>Make sure that <span class='ec-lmtt-10'>ScanPolicy </span>restricts loading from undesired devices. It is a good idea to prohibit all removable
     drivers or unknown filesystems.
     </li>
<li class='enumerate' id='x1-95012x6'>Sign all the installed drivers and tools with the private key. Do not sign tools that provide administrative access
     to the computer, such as UEFI Shell.
     </li>
<li class='enumerate' id='x1-95014x7'>Vault the configuration as explained <a href='#x1-46036x11'>Vaulting</a> section.
     </li>
<li class='enumerate' id='x1-95016x8'>Sign all OpenCore binaries (<span class='ec-lmtt-10'>BOOTX64.efi</span>, <span class='ec-lmtt-10'>BOOTIa32.efi</span>, <span class='ec-lmtt-10'>OpenCore.efi</span>, custom launchers) used on this system
     with the same private key.
     </li>
<li class='enumerate' id='x1-95018x9'>Sign all third-party operating system (not made by Microsoft or Apple) bootloaders if needed. For Linux there
     is an option to install Microsoft-signed Shim bootloader as explained on e.g. <a href='https://wiki.debian.org/SecureBoot'>Debian Wiki</a>.
     </li>
<li class='enumerate' id='x1-95020x10'>Enable UEFI Secure Boot in firmware preferences and install the certificate with a private key. Details on how to
     generate a certificate can be found in various articles, such as <a href='https://habr.com/en/post/273497'>this one</a>, and are out of the scope of this document.
     If Windows is needed one will also need to add the <a href='http://go.microsoft.com/fwlink/?LinkID=321192'>Microsoft Windows Production CA 2011</a>. To launch option
     ROMs or to use signed Linux drivers, <a href='http://go.microsoft.com/fwlink/?LinkId=321194'>Microsoft UEFI Driver Signing CA</a> will also be needed.
                                                                                                  
                                                                                                  
     </li>
<li class='enumerate' id='x1-95022x11'>Password-protect changing firmware settings to ensure that UEFI Secure Boot cannot be disabled without the
     user’s knowledge.</li></ol>
<!-- l. 8751 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='windows-support'><span class='titlemark'>12.3   </span> <a id='x1-9600012.3'></a>Windows support</h4>
<!-- l. 8753 --><p class='noindent'><span class='ec-lmbx-10'>Can I install Windows?</span>
</p><!-- l. 8755 --><p class='noindent'>While no official Windows support is provided, 64-bit UEFI Windows installations (Windows 8 and above) prepared with Boot
Camp are supposed to work. Third-party UEFI installations as well as systems partially supporting UEFI boot, such as
Windows 7, might work with some extra precautions. Things to consider:
</p>
     <ul class='itemize1'>
     <li class='itemize'>MBR (Master Boot Record) installations are legacy and will not be supported.
     </li>
     <li class='itemize'>All the modifications applied (to ACPI, NVRAM, SMBIOS, etc.) are supposed to be operating system agnostic,
     i.e. apply equally regardless of the OS booted. This enables Boot Camp software experience on Windows.
     </li>
     <li class='itemize'>macOS requires the first partition to be EFI System Partition, and does not support the default Windows layout.
     While OpenCore does have a <a href='https://github.com/acidanthera/bugtracker/issues/327'>workaround</a> for this, it is highly recommend not to rely on it and install properly.
     </li>
     <li class='itemize'>Windows may need to be reactivated. To avoid it consider setting SystemUUID to the original firmware UUID.
     Be aware that it may be invalid on old firmware, i.e., not random. If there still are issues, consider using HWID
     or KMS38 license or making the use <span class='ec-lmtt-10'>Custom UpdateSMBIOSMode</span>. Other nuances of Windows activation are out
     of the scope of this document and can be found online.</li></ul>
<!-- l. 8777 --><p class='noindent'><span class='ec-lmbx-10'>What additional software do I need?</span>
</p><!-- l. 8779 --><p class='noindent'>To enable operating system switching and install relevant drivers in the majority of cases Windows support software from <a href='https://support.apple.com/boot-camp'>Boot
Camp</a> is required. For simplicity of the download process or when configuring an already installed Windows version a
third-party utility, <a href='https://github.com/timsutton/brigadier'>Brigadier</a>, can be used successfully. Note, that <a href='https://www.7-zip.org'>7-Zip</a> may be downloaded and installed prior to using
Brigadier.
</p><!-- l. 8787 --><p class='noindent'>Remember to always use the latest version of Windows support software from Boot Camp, as versions prior to 6.1 do
not support APFS, and thus will not function correctly. To download newest software pass most recent Mac
model to Brigadier, for example <span class='ec-lmtt-10'>./brigadier.exe -m iMac19,1</span>. To install Boot Camp on an unsupported Mac
model afterwards run PowerShell as Administrator and enter <span class='ec-lmtt-10'>msiexec /i BootCamp.msi</span>. If there is a previous
version of Boot Camp installed it should be removed first by running <span class='ec-lmtt-10'>msiexec /x BootCamp.msi </span>command.
<span class='ec-lmtt-10'>BootCamp.msi </span>file is located in <span class='ec-lmtt-10'>BootCamp/Drivers/Apple </span>directory and can be reached through Windows
Explorer.
</p><!-- l. 8797 --><p class='noindent'>While Windows support software from Boot Camp solves most of compatibility problems, the rest may still have to be
addressed manually:
</p>
                                                                                                  
                                                                                                  
     <ul class='itemize1'>
     <li class='itemize'>To invert mouse wheel scroll direction <span class='ec-lmtt-10'>FlipFlopWheel </span>must be set to <span class='ec-lmtt-10'>1 </span>as explained on <a href='https://superuser.com/a/364353'>SuperUser</a>.
     </li>
     <li class='itemize'><span class='ec-lmtt-10'>RealTimeIsUniversal </span>must be set to <span class='ec-lmtt-10'>1 </span>to avoid time desync between Windows and macOS as explained on
     <a href='https://superuser.com/q/494432'>SuperUser</a> (this is typically not required).
     </li>
     <li class='itemize'>To access Apple filesystems such as HFS+ and APFS, separate software may need to be installed. Some of the
     known utilities are: <a href='https://forums.macrumors.com/threads/apple-hfs-windows-driver-download.1368010/'>Apple HFS+ driver</a> (<a href='https://forums.macrumors.com/threads/apple-hfs-windows-driver-download.1368010/post-24180079'>workaround for Windows 10</a>), <a href='http://www.catacombae.org/hfsexplorer'>HFSExplorer</a>, MacDrive, Paragon APFS,
     Paragon HFS+, TransMac, etc. Remember to never ever attempt to modify Apple file systems from Windows
     as this often leads to irrecoverable data loss.</li></ul>
<!-- l. 8815 --><p class='noindent'><span class='ec-lmbx-10'>Why do I see </span><span class='ec-lmtk-10'>Basic data partition </span><span class='ec-lmbx-10'>in the Boot Camp Startup Disk control panel?</span>
</p><!-- l. 8817 --><p class='noindent'>The Boot Camp control panel uses the GPT partition table to obtain each boot option name. After installing Windows
separately, the partition has to be relabelled manually. This can be done with many utilities including the open-source <a href='https://sourceforge.net/projects/gptfdisk'>gdisk</a>
utility. Reference example:
</p>
<!-- l. 8822 -->
<p id='-relabeling-windows-volume'><a id='x1-96001r4'></a>
<a id='x1-96002'></a>
</p><pre class='lstlisting' id='listing-18'><span class='label'><a id='x1-96003r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>PS</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>C:\gdisk&gt; </span><span class='ec-lmtt-10'>.\gdisk64.exe </span><span class='ec-lmtt-10'>\\.\physicaldrive0</span> 
</span><span class='label'><a id='x1-96004r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>GPT</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>fdisk </span><span class='ec-lmtt-10'>(gdisk) </span><span class='ec-lmtt-10'>version </span><span class='ec-lmtt-10'>1.0.4</span> 
</span><span class='label'><a id='x1-96005r3'></a></span> 
<span class='label'><a id='x1-96006r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Command</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>(? </span><span class='ec-lmtk-10'>for </span><span class='ec-lmtk-10'>help</span><span class='ec-lmtt-10'>): </span><span class='ec-lmtt-10'>p</span> 
</span><span class='label'><a id='x1-96007r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Disk</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>\\.\physicaldrive0: </span><span class='ec-lmtt-10'>419430400 </span><span class='ec-lmtt-10'>sectors, </span><span class='ec-lmtt-10'>200.0 </span><span class='ec-lmtt-10'>GiB</span> 
</span><span class='label'><a id='x1-96008r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Sector</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>size </span><span class='ec-lmtt-10'>(logical): </span><span class='ec-lmtt-10'>512 </span><span class='ec-lmtt-10'>bytes</span> 
</span><span class='label'><a id='x1-96009r7'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Disk</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>identifier </span><span class='ec-lmtt-10'>(GUID): </span><span class='ec-lmtt-10'>DEC57EB1-B3B5-49B2-95F5-3B8C4D3E4E12</span> 
</span><span class='label'><a id='x1-96010r8'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Partition</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>table </span><span class='ec-lmtt-10'>holds </span><span class='ec-lmtt-10'>up </span><span class='ec-lmtt-10'>to </span><span class='ec-lmtt-10'>128 </span><span class='ec-lmtt-10'>entries</span> 
</span><span class='label'><a id='x1-96011r9'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Main</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>partition </span><span class='ec-lmtt-10'>table </span><span class='ec-lmtt-10'>begins </span><span class='ec-lmtt-10'>at </span><span class='ec-lmtt-10'>sector </span><span class='ec-lmtt-10'>2 </span><span class='ec-lmtt-10'>and </span><span class='ec-lmtt-10'>ends </span><span class='ec-lmtt-10'>at </span><span class='ec-lmtt-10'>sector </span><span class='ec-lmtt-10'>33</span> 
</span><span class='label'><a id='x1-96012r10'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>First</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>usable </span><span class='ec-lmtt-10'>sector </span><span class='ec-lmtt-10'>is </span><span class='ec-lmtt-10'>34, </span><span class='ec-lmtt-10'>last </span><span class='ec-lmtt-10'>usable </span><span class='ec-lmtt-10'>sector </span><span class='ec-lmtt-10'>is </span><span class='ec-lmtt-10'>419430366</span> 
</span><span class='label'><a id='x1-96013r11'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Partitions</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>will </span><span class='ec-lmtt-10'>be </span><span class='ec-lmtt-10'>aligned </span><span class='ec-lmtt-10'>on </span><span class='ec-lmtt-10'>2048-sector </span><span class='ec-lmtt-10'>boundaries</span> 
</span><span class='label'><a id='x1-96014r12'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Total</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>free </span><span class='ec-lmtt-10'>space </span><span class='ec-lmtt-10'>is </span><span class='ec-lmtt-10'>4029 </span><span class='ec-lmtt-10'>sectors </span><span class='ec-lmtt-10'>(2.0 </span><span class='ec-lmtt-10'>MiB)</span> 
</span><span class='label'><a id='x1-96015r13'></a></span> 
<span class='label'><a id='x1-96016r14'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Number</span></span><span style='color:#000000'>  <span class='ec-lmtt-10'>Start </span><span class='ec-lmtt-10'>(sector) </span>   <span class='ec-lmtt-10'>End </span><span class='ec-lmtt-10'>(sector) </span> <span class='ec-lmtt-10'>Size </span>      <span class='ec-lmtt-10'>Code </span> <span class='ec-lmtt-10'>Name</span> 
</span><span class='label'><a id='x1-96017r15'></a></span><span style='color:#000000'>   <span class='ec-lmtt-10'>1 </span>           <span class='ec-lmtt-10'>2048 </span>        <span class='ec-lmtt-10'>1023999 </span>  <span class='ec-lmtt-10'>499.0 </span><span class='ec-lmtt-10'>MiB </span>  <span class='ec-lmtt-10'>2700 </span> <span class='ec-lmtt-10'>Basic </span><span class='ec-lmtt-10'>data </span><span class='ec-lmtt-10'>partition</span> 
</span><span class='label'><a id='x1-96018r16'></a></span><span style='color:#000000'>   <span class='ec-lmtt-10'>2 </span>        <span class='ec-lmtt-10'>1024000 </span>        <span class='ec-lmtt-10'>1226751 </span>  <span class='ec-lmtt-10'>99.0 </span><span class='ec-lmtt-10'>MiB </span>   <span class='ec-lmtt-10'>EF00 </span> <span class='ec-lmtt-10'>EFI </span><span class='ec-lmtt-10'>system </span><span class='ec-lmtt-10'>partition</span> 
</span><span class='label'><a id='x1-96019r17'></a></span><span style='color:#000000'>   <span class='ec-lmtt-10'>3 </span>        <span class='ec-lmtt-10'>1226752 </span>        <span class='ec-lmtt-10'>1259519 </span>  <span class='ec-lmtt-10'>16.0 </span><span class='ec-lmtt-10'>MiB </span>   <span class='ec-lmtt-10'>0C01 </span> <span class='ec-lmtt-10'>Microsoft </span><span class='ec-lmtt-10'>reserved </span><span class='ec-lmtt-10'>...</span> 
</span><span class='label'><a id='x1-96020r18'></a></span><span style='color:#000000'>   <span class='ec-lmtt-10'>4 </span>        <span class='ec-lmtt-10'>1259520 </span>      <span class='ec-lmtt-10'>419428351 </span>  <span class='ec-lmtt-10'>199.4 </span><span class='ec-lmtt-10'>GiB </span>  <span class='ec-lmtt-10'>0700 </span> <span class='ec-lmtt-10'>Basic </span><span class='ec-lmtt-10'>data </span><span class='ec-lmtt-10'>partition</span> 
</span><span class='label'><a id='x1-96021r19'></a></span> 
<span class='label'><a id='x1-96022r20'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Command</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>(? </span><span class='ec-lmtk-10'>for </span><span class='ec-lmtk-10'>help</span><span class='ec-lmtt-10'>): </span><span class='ec-lmtt-10'>c</span> 
</span><span class='label'><a id='x1-96023r21'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Partition</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>number </span><span class='ec-lmtt-10'>(1-4): </span><span class='ec-lmtt-10'>4</span> 
</span><span class='label'><a id='x1-96024r22'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Enter</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>name: </span><span class='ec-lmtt-10'>BOOTCAMP</span> 
</span><span class='label'><a id='x1-96025r23'></a></span> 
<span class='label'><a id='x1-96026r24'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Command</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>(? </span><span class='ec-lmtk-10'>for </span><span class='ec-lmtk-10'>help</span><span class='ec-lmtt-10'>): </span><span class='ec-lmtt-10'>w</span> 
</span><span class='label'><a id='x1-96027r25'></a></span> 
<span class='label'><a id='x1-96028r26'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Final</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>checks </span><span class='ec-lmtk-10'>complete</span><span class='ec-lmtt-10'>. </span><span class='ec-lmtt-10'>About </span><span class='ec-lmtt-10'>to </span><span class='ec-lmtt-10'>write </span><span class='ec-lmtt-10'>GPT </span><span class='ec-lmtt-10'>data. </span><span class='ec-lmtt-10'>THIS </span><span class='ec-lmtt-10'>WILL </span><span class='ec-lmtt-10'>OVERWRITE </span><span class='ec-lmtt-10'>EXISTING </span><span class='ec-lmtt-10'>PARTITIONS!!</span> 
</span><span class='label'><a id='x1-96029r27'></a></span> 
<span class='label'><a id='x1-96030r28'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Do</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>you </span><span class='ec-lmtt-10'>want </span><span class='ec-lmtt-10'>to </span><span class='ec-lmtt-10'>proceed? </span><span class='ec-lmtt-10'>(Y/N): </span><span class='ec-lmtt-10'>Y</span> 
</span><span class='label'><a id='x1-96031r29'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>OK</span></span><span style='color:#000000'><span class='ec-lmtt-10'>;</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>writing </span><span class='ec-lmtt-10'>new </span><span class='ec-lmtt-10'>GUID </span><span class='ec-lmtt-10'>partition </span><span class='ec-lmtt-10'>table </span><span class='ec-lmtt-10'>(GPT) </span><span class='ec-lmtt-10'>to </span><span class='ec-lmtt-10'>\\.\physicaldrive0.</span> 
</span><span class='label'><a id='x1-96032r30'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Disk</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>synchronization </span><span class='ec-lmtt-10'>succeeded! </span><span class='ec-lmtt-10'>The </span><span class='ec-lmtt-10'>computer </span><span class='ec-lmtt-10'>should </span><span class='ec-lmtt-10'>now </span><span class='ec-lmtt-10'>use </span><span class='ec-lmtt-10'>the </span><span class='ec-lmtt-10'>new </span><span class='ec-lmtt-10'>partition </span><span class='ec-lmtt-10'>table.</span> 
</span><span class='label'><a id='x1-96033r31'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>The</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>operation </span><span class='ec-lmtt-10'>has </span><span class='ec-lmtt-10'>completed </span><span class='ec-lmtt-10'>successfully.</span></span></pre>
<figcaption class='caption'><span class='id'>Listing 4: </span><span class='content'>Relabeling Windows volume</span></figcaption><!-- tex4ht:label?: x1-96033r12.3  -->
<!-- l. 8857 --><p class='noindent'><span class='ec-lmbx-10'>How do I choose Windows BOOTCAMP with custom NTFS drivers?</span>
</p><!-- l. 8859 --><p class='noindent'>Third-party drivers providing NTFS support, such as <a href='https://www.tuxera.com/community/open-source-ntfs-3g'>NTFS-3G</a>, Paragon NTFS, Tuxera NTFS or <a href='https://www.seagate.com/support/software/paragon'>Seagate Paragon Driver</a>
disrupt certain macOS functionality, including the <a href='https://support.apple.com/HT202796'>Startup Disk</a> preference pane normally used for operating system selection.
While the recommended option remains not to use such drivers as they commonly corrupt the filesystem, and prefer the driver
bundled with macOS with optional write support ( <a href='http://osxdaily.com/2013/10/02/enable-ntfs-write-support-mac-os-x'>command</a> or <a href='https://mounty.app'>GUI</a>), there still exist vendor-specific workarounds for their
products: <a href='https://www.tuxera.com/products/tuxera-ntfs-for-mac/faq'>Tuxera</a>, <a href='https://kb.paragon-software.com/article/6604'>Paragon</a>, etc.
</p><!-- l. 8873 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='debugging1'><span class='titlemark'>12.4   </span> <a id='x1-9700012.4'></a>Debugging</h4>
<!-- l. 8875 --><p class='noindent'>Similar to other projects working with hardware OpenCore supports auditing and debugging. The use of <span class='ec-lmtt-10'>NOOPT </span>or <span class='ec-lmtt-10'>DEBUG </span>build
modes instead of <span class='ec-lmtt-10'>RELEASE </span>can produce a lot more debug output. With <span class='ec-lmtt-10'>NOOPT </span>source level debugging with GDB or IDA Pro is
also available. For GDB check <a href='https://github.com/acidanthera/OpenCorePkg/tree/master/Debug'>OpenCore Debug</a> page. For IDA Pro, version 7.3 or newer is needed, and <a href='https://www.hex-rays.com/products/ida/support/tutorials/index.shtml'>Debugging the XNU
Kernel with IDA Pro</a> may also help.
</p><!-- l. 8884 --><p class='noindent'>To obtain the log during boot serial port debugging can be used. Serial port debugging is enabled in <span class='ec-lmtt-10'>Target</span>, e.g. <span class='ec-lmtt-10'>0xB </span>for
onscreen with serial. To initialise serial within OpenCore use <span class='ec-lmtt-10'>Init </span>configuration option under <span class='ec-lmtt-10'>Misc-&gt;Serial </span>with other values
properly set. For macOS the best choice is CP2102-based UART devices. Connect motherboard <span class='ec-lmtt-10'>TX </span>to USB UART <span class='ec-lmtt-10'>RX</span>, and
motherboard <span class='ec-lmtt-10'>GND </span>to USB UART <span class='ec-lmtt-10'>GND</span>. Use <span class='ec-lmtt-10'>screen </span>utility to get the output, or download GUI software, such as
<a href='https://freeware.the-meiers.org'>CoolTerm</a>.
</p><!-- l. 8892 --><p class='noindent'><span class='ec-lmri-10'>Note</span>: On several motherboards (and possibly USB UART dongles) PIN naming may be incorrect. It is very common to have
<span class='ec-lmtt-10'>GND </span>swapped with <span class='ec-lmtt-10'>RX</span>, thus, motherboard “<span class='ec-lmtt-10'>TX</span>” must be connected to USB UART <span class='ec-lmtt-10'>GND</span>, and motherboard “<span class='ec-lmtt-10'>GND</span>” to USB UART
<span class='ec-lmtt-10'>RX</span>.
                                                                                                  
                                                                                                  
</p><!-- l. 8897 --><p class='noindent'>Remember to enable <span class='ec-lmtt-10'>COM </span>port in firmware settings, and never use USB cables longer than 1 meter to avoid output corruption.
To additionally enable XNU kernel serial output <span class='ec-lmtt-10'>debug=0x8 </span>boot argument is needed.
</p><!-- l. 8901 --><p class='noindent'>
</p>
<h4 class='subsectionHead' id='tips-and-tricks'><span class='titlemark'>12.5   </span> <a id='x1-9800012.5'></a>Tips and Tricks</h4>
<!-- l. 8903 --><p class='noindent'>
     </p><ol class='enumerate1'>
<li class='enumerate' id='x1-98002x1'>
     <!-- l. 8905 --><p class='noindent'><span class='ec-lmbx-10'>How do I debug boot failures?</span>
     </p><!-- l. 8907 --><p class='noindent'>Obtaining the actual error message is usually adequate. For this, ensure that: </p>
         <ul class='itemize1'>
         <li class='itemize'>A <span class='ec-lmtt-10'>DEBUG </span>or <span class='ec-lmtt-10'>NOOPT </span>version of OpenCore is used.
         </li>
         <li class='itemize'>Logging is enabled (<span class='ec-lmtt-10'>1</span>) and shown onscreen (<span class='ec-lmtt-10'>2</span>): <span class='ec-lmtt-10'>Misc </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>Debug </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>Target </span><span class='rm-lmr-10'>= </span><span class='ec-lmtt-10'>3</span>.
         </li>
         <li class='itemize'>Logged messages from at least <span class='ec-lmtt-10'>DEBUG_ERROR </span>(<span class='ec-lmtt-10'>0x80000000</span>), <span class='ec-lmtt-10'>DEBUG_WARN </span>(<span class='ec-lmtt-10'>0x00000002</span>), and <span class='ec-lmtt-10'>DEBUG_INFO</span>
         (<span class='ec-lmtt-10'>0x00000040</span>) levels are visible onscreen: <span class='ec-lmtt-10'>Misc </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>Debug </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>DisplayLevel </span><span class='rm-lmr-10'>= </span><span class='ec-lmtt-10'>0x80000042</span>.
         </li>
         <li class='itemize'>Critical error messages, such as <span class='ec-lmtt-10'>DEBUG_ERROR</span>, stop booting: <span class='ec-lmtt-10'>Misc</span><span class='lmsy-10'>→</span><span class='ec-lmtt-10'>Security</span><span class='lmsy-10'>→</span><span class='ec-lmtt-10'>HaltLevel </span><span class='rm-lmr-10'>= </span><span class='ec-lmtt-10'>0x80000000</span>.
         </li>
         <li class='itemize'>Watch Dog is disabled to prevent automatic reboot: <span class='ec-lmtt-10'>Misc </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>Debug </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>DisableWatchDog </span><span class='rm-lmr-10'>= </span><span class='ec-lmtt-10'>true</span>.
         </li>
         <li class='itemize'>Boot Picker (entry selector) is enabled: <span class='ec-lmtt-10'>Misc </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>Boot </span><span class='lmsy-10'>→ </span><span class='ec-lmtt-10'>ShowPicker </span><span class='rm-lmr-10'>= </span><span class='ec-lmtt-10'>true</span>.</li></ul>
     <!-- l. 8929 --><p class='noindent'>If there is no obvious error, check the available workarounds in the <span class='ec-lmtt-10'>Quirks </span>sections one by one. For early boot
     troubleshooting, for instance, when OpenCore menu does not appear, using <span class='ec-lmtt-10'>UEFI Shell </span>(bundled with OpenCore) may
     help to see early debug messages.
     </p></li>
<li class='enumerate' id='x1-98004x2'>
     <!-- l. 8935 --><p class='noindent'><span class='ec-lmbx-10'>How do I debug macOS boot failures?</span>
</p>
         <ul class='itemize1'>
         <li class='itemize'>Refer to <span class='ec-lmtt-10'>boot-args </span>values such as <span class='ec-lmtt-10'>debug=0x100</span>, <span class='ec-lmtt-10'>keepsyms=1</span>, <span class='ec-lmtt-10'>-v</span>, and similar.
         </li>
         <li class='itemize'>Do not forget about <span class='ec-lmtt-10'>AppleDebug </span>and <span class='ec-lmtt-10'>ApplePanic </span>properties.
         </li>
         <li class='itemize'>For macOS to correctly recognise and set up serial ports, the <span class='ec-lmtt-10'>CustomPciSerialDevice </span>quirk may be enabled
         when a PCI serial port card is installed.
                                                                                                  
                                                                                                  
         </li>
         <li class='itemize'>Take care of <span class='ec-lmtt-10'>Booter</span>, <span class='ec-lmtt-10'>Kernel</span>, and <span class='ec-lmtt-10'>UEFI </span>quirks.
         </li>
         <li class='itemize'>Consider using serial port to inspect early kernel boot failures. For this <span class='ec-lmtt-10'>debug=0x108</span>, <span class='ec-lmtt-10'>serial=5</span>, and
         <span class='ec-lmtt-10'>msgbuf=1048576 </span>boot arguments are needed. Refer to the patches in Sample.plist when dying before serial
         init.
         </li>
         <li class='itemize'>Always read the logs carefully.</li></ul>
     </li>
<li class='enumerate' id='x1-98006x3'>
     <!-- l. 8952 --><p class='noindent'><span class='ec-lmbx-10'>How do I customise boot entries?</span>
     </p><!-- l. 8954 --><p class='noindent'>OpenCore follows standard Apple Bless model and extracts the entry name from <span class='ec-lmtt-10'>.contentDetails </span>and
     <span class='ec-lmtt-10'>.disk_label.contentDetails </span>files in the booter directory if present. These files contain an ASCII string with an entry
     title, which may then be customised by the user.
     </p></li>
<li class='enumerate' id='x1-98008x4'>
     <!-- l. 8960 --><p class='noindent'><span class='ec-lmbx-10'>How do I choose the default boot entry?</span>
     </p><!-- l. 8962 --><p class='noindent'>OpenCore uses the primary UEFI boot option to select the default entry. This choice can be altered from UEFI Setup,
     with the macOS <a href='https://support.apple.com/HT202796'>Startup Disk</a> preference, or the Windows <a href='https://support.apple.com/guide/bootcamp-control-panel/start-up-your-mac-in-windows-or-macos-bcmp29b8ac66/mac'>Boot Camp</a> Control Panel. Since choosing OpenCore’s
     <span class='ec-lmtt-10'>BOOTx64.EFI </span>as a primary boot option limits this functionality in addition to several types of firmware deleting
     incompatible boot options, potentially including those created by macOS, users are strongly encouraged to
     use the <span class='ec-lmtt-10'>RequestBootVarRouting </span>quirk, which will preserve the selection made in the operating system
     within the OpenCore variable space. Note, that <span class='ec-lmtt-10'>RequestBootVarRouting </span>requires a separate driver for
     functioning.
     </p></li>
<li class='enumerate' id='x1-98010x5'>
     <!-- l. 8973 --><p class='noindent'> <span class='ec-lmbx-10'>What is the simplest way to install macOS?</span>
     </p><!-- l. 8976 --><p class='noindent'>Copy online recovery image (<span class='ec-lmtt-10'>*.dmg </span>and <span class='ec-lmtt-10'>*.chunklist </span>files) to <span class='ec-lmtt-10'>com.apple.recovery.boot </span>directory on a FAT32 partition
     with OpenCore. Load the OpenCore picker and choose the entry, it will have a <span class='ec-lmtt-10'>(dmg) </span>suffix. Custom name may be
     created by providing <span class='ec-lmtt-10'>.contentDetails </span>file.
     </p><!-- l. 8981 --><p class='noindent'>To download recovery online <a href='https://github.com/acidanthera/OpenCorePkg/blob/master/Utilities/macrecovery/macrecovery.py'>macrecovery.py</a> can be used.
     </p><!-- l. 8985 --><p class='noindent'>For offline installation refer to <a href='https://support.apple.com/HT201372'>How to create a bootable installer for macOS</a> article. Apart from App Store and
     <span class='ec-lmtt-10'>softwareupdate </span>utility there also are <a href='https://github.com/corpnewt/gibMacOS'>third-party utilities</a> to download an offline image.
     </p></li>
<li class='enumerate' id='x1-98012x6'>
     <!-- l. 8991 --><p class='noindent'><span class='ec-lmbx-10'>Why do online recovery images (</span><span class='ec-lmtk-10'>*.dmg</span><span class='ec-lmbx-10'>) fail to load?</span>
     </p><!-- l. 8993 --><p class='noindent'>This may be caused by missing HFS+ driver, as all presently known recovery volumes have HFS+ filesystem.
     </p></li>
<li class='enumerate' id='x1-98014x7'>
     <!-- l. 8997 --><p class='noindent'><span class='ec-lmbx-10'>Can I use this on Apple hardware or virtual machines?</span>
                                                                                                  
                                                                                                  
     </p><!-- l. 8999 --><p class='noindent'>Sure, most relatively modern Mac models including <span class='ec-lmtt-10'>MacPro5,1 </span>and virtual machines are fully supported. Even though
     there are little to none specific details relevant to Mac hardware, some ongoing instructions can be found on
     <a href='https://forums.macrumors.com/threads/opencore-on-the-mac-pro.2207814'>MacRumors.com</a>.
     </p></li>
<li class='enumerate' id='x1-98016x8'>
     <!-- l. 9005 --><p class='noindent'><span class='ec-lmbx-10'>Why must Find&amp;Replace patches be equal in size?</span>
     </p><!-- l. 9007 --><p class='noindent'>For machine code (x86 code) it is not possible to do differently sized replacements due to <a href='https://en.wikipedia.org/w/index.php?title=Relative_addressing'>relative addressing</a>. For ACPI
     code this is risky, and is technically equivalent to ACPI table replacement, thus not implemented. More detailed
     explanation can be found on <a href='https://applelife.ru/posts/819790'>AppleLife.ru</a> or in the ACPI section of this document.
     </p></li>
<li class='enumerate' id='x1-98018x9'>
     <!-- l. 9014 --><p class='noindent'><span class='ec-lmbx-10'>How can I decide which </span><span class='ec-lmtk-10'>Booter </span><span class='ec-lmbx-10'>quirks to use?</span>
     </p><!-- l. 9016 --><p class='noindent'>These quirks originate from <span class='ec-lmtt-10'>AptioMemoryFix </span>driver but provide a wider set of changes specific to modern systems. Note,
     that <span class='ec-lmtt-10'>OpenRuntime </span>driver is required for most configurations. To get a configuration similar to <span class='ec-lmtt-10'>AptioMemoryFix </span>the
     following set of quirks should be enabled: </p>
         <ul class='itemize1'>
         <li class='itemize'><span class='ec-lmtt-10'>ProvideConsoleGop </span>(UEFI quirk)
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>AvoidRuntimeDefrag</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>DiscardHibernateMap</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>EnableSafeModeSlide</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>EnableWriteUnprotector</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ForceExitBootServices</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ProtectMemoryRegions</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>ProvideCustomSlide</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>RebuildAppleMemoryMap</span>
         </li>
         <li class='itemize'><span class='ec-lmtt-10'>SetupVirtualMap</span></li></ul>
     <!-- l. 9034 --><p class='noindent'>However, as of today, such set is strongly discouraged as some of these quirks are not necessary to be enabled or need
     additional quirks. For example, <span class='ec-lmtt-10'>DevirtualiseMmio </span>and <span class='ec-lmtt-10'>ProtectUefiServices </span>are often required, while
     <span class='ec-lmtt-10'>DiscardHibernateMap </span>and <span class='ec-lmtt-10'>ForceExitBootServices </span>are rarely necessary.
     </p><!-- l. 9040 --><p class='noindent'>Unfortunately for some quirks such as <span class='ec-lmtt-10'>RebuildAppleMemoryMap</span>, <span class='ec-lmtt-10'>EnableWriteUnprotector</span>, <span class='ec-lmtt-10'>ProtectMemoryRegions</span>,
     <span class='ec-lmtt-10'>SetupVirtualMap</span>, and <span class='ec-lmtt-10'>SyncRuntimePermissions </span>there is no definite approach even on similar systems, so trying all
     their combinations may be required for optimal setup. Refer to individual quirk descriptions in this document for
                                                                                                  
                                                                                                  
     details.
</p>
     </li></ol>
 
</body> 
</html>